Solon MVC 的 @Mapping 用法说明
xsobi 2024-12-06 20:28 1 浏览
在 Solon Mvc 里,@Mapping 注解一般是配合 @Controller 和 @Remoting,作请求路径映射用的。且,只支持加在 public 函数 或 类上。
1、注解属性
属性 | 说明 | 备注 |
value | 路径 | 与 path 互为别名 |
path | 路径 | 与 value 互为别名 |
method | 请求方式限定(def=all) | 可用 @Post、@Get 等注解替代此属性 |
consumes | 指定处理请求的提交内容类型 | 可用 @Consumes 注解替代此属性 |
produces | 指定返回的内容类型 | 可用 @Produces 注解替代此属性 |
multipart | 申明支持多分片请求(def=false) | 如果为false,则自动识别 |
当 method=all,即不限定请求方式
2、支持的路径映射表达式
符号 | 说明 | 示例 |
** | 任意字符、不限段数 | ** 或 /user/** |
* | 任意字符 | /user/* |
? | 可有可无 | /user/? |
/ | 路径片段开始符和间隔符 | / 或 /user |
{name} | 路径变量申明 | /user/{name} |
路径组合(控制器映射与动作映射)及应用示例:
import org.noear.solon.annotation.Controller;
import org.noear.solon.annotation.Mapping;
@Mapping("/user") //或 "user",开头自动会补"/"
@Controller
public void DemoController{
@Mapping("") //=/user
public void home(){ }
@Mapping("/") //=/user/,与上面是有区别的,注意下。
public void home2(){ }
@Mapping("/?") //=/user/ 或者 /user,与上面是有区别的,注意下。
public void home3(){ }
@Mapping("list") //=/user/list ,间隔自动会补"/"
public void getList(){ }
@Mapping("/{id}") //=/user/{id}
public void getOne(long id){ }
@Mapping("/ajax/**") //=/user/ajax/**
public void ajax(){ }
}
提醒:一个 @Mapping 函数不支持多个路径的映射
3、参数注入
非请求参数的可注入对象:
类型 | 说明 |
Context | 请求上下文(org.noear.solon.core.handle.Context) |
Locale | 请求的地域信息,国际化时需要 |
ModelAndView | 模型与视图对象(org.noear.solon.core.handle.ModelAndView) |
支持请求参数自动转换注入:
- 当变量名有对应的请求参数时(即有名字可对上的请求参数)会直接尝试对请求参数值进行类型转换
- 当变量名没有对应的请求参数时当变量为实体时:会尝试所有请求参数做为属性注入否则注入 null
支持多种形式的请求参数直接注入:
- queryString
- form-data
- x-www-form-urlencoded
- path
- json body
其中 queryString, form-data, x-www-form-urlencoded, path 参数,支持 ctx.param() 接口统一获取。
import org.noear.solon.core.handle.Context;
import org.noear.solon.core.handle.ModelAndView;
import org.noear.solon.core.handle.UploadedFile;
import java.util.Locale;
@Mapping("/user")
@Controller
public void DemoController{
//非请求参数的可注入对象
@Mapping("case1")
public void case1(Context ctx, Locale locale , ModelAndView mv){ }
//请求参数(可以是散装的;支持 queryString, form;json,或支持的其它序列化格式)
@Mapping("case2")
public void case2(String userName, String nickName, long[] ids, List<String> names){ }
//请求参数(可以是整装的结构体;支持 queryString, form;json,或支持的其它序列化格式Mapping
@Mapping("case3")
public void case3(UserModel user){ }
//也可以是混搭的
@Mapping("case4")
public void case4(Context ctx, UserModel user, String userName){ }
//文件上传 //注意与 <input type='file' name="file1" /> 名字对上
@Mapping("case5")
public void case5(UploadedFile file1, UploadedFile file2){ }
//同名多文件上传
@Mapping("case6")
public void case6(UploadedFile[] file){ }
}
提醒: ?user[name]=1&ip[0]=a&ip[1]=b&order.id=1 风格的参数注入,需要引入插件:solon-serialization-properties
4、带注解的参数注入
注解:
注解 | 说明 |
@Param | 注入请求参数(包括:query-string、form)。起到指定名字、默认值等作用 |
@Header | 注入请求 header |
@Cookie | 注入请求 cookie |
@Path | 注入请求 path 变量(因为框架会自动处理,所以这个只是标识下方便文档生成用) |
@Body | 注入请求体(一般会自动处理。仅在主体的 String, InputSteam, Map 时才需要) |
注解相关属性:
属性 | 说明 | 适用注解 |
value | 参数名字 | @Param, @Header, @Cookie, @Path |
name | 参数名字(与 value 互为别名) | @Param, @Header, @Cookie, @Path |
required | 必须的 | @Param, @Header, @Cookie, @Body |
defaultValue | 默认值 | @Param, @Header, @Cookie, @Body |
import org.noear.solon.annotation.Controller;
import org.noear.solon.annotation.Mapping;
import org.noear.solon.annotation.Header;
import org.noear.solon.annotation.Body;
import org.noear.solon.annotation.Path;
@Mapping("/user")
@Controller
public void DemoController{
@Mapping("case1")
public void case1(@Body String bodyStr){ }
@Mapping("case2")
public void case2(@Body Map<String,String> paramMap, @Header("Token") String token){ }
@Mapping("case3")
public void case3(@Body InputStream stream, @Cookie("Token") token){ }
//这个用例加不加 @Body 效果一样
@Mapping("case4")
public void case4(@Body UserModel user){ }
@Mapping("case5/{id}")
public void case5(String id){ }
//如果名字不同,才有必要用 @Path //否则是自动处理(如上)
@Mapping("case5_2/{id}")
public void case5_2(@Path("id") String name){ }
@Mapping("case6")
public void case6(String name){ }
//如果名字不同,才有必要用 @Param //否则是自动处理(如上)
@Mapping("case6_2")
public void case6_2(@Param("id") String name){ }
//如果要默认值,才有必要用 @Param
@Mapping("case6_3")
public void case6_3(@Param(defaultValue="world") String name){ }
@Mapping("case7")
public void case7(@Header String token){ }
@Mapping("case7_2")
public void case7_2(@Header String[] user){ } //v2.4.0 后支持
}
5、请求方式限定
可以1个或多个加个 @Mppaing 注解上,用于限定请求方式(不限,则支持全部请求方式)
请求方式限定注解 | 说明 |
@Get | 限定为 Http Get 请求方式 |
@Post | 限定为 Http Post 请求方式 |
@Put | 限定为 Http Put 请求方式 |
@Delete | 限定为 Http Delete 请求方式 |
@Patch | 限定为 Http Patch 请求方式 |
@Head | 限定为 Http Head 请求方式 |
@Options | 限定为 Http Options 请求方式 |
@Trace | 限定为 Http Trace 请求方式 |
@Http | 限定为 Http 所有请求方式 |
@Message | 限定为 Message 请求方式 |
@To | 标注转发目标 |
@WebSokcet | 限定为 WebSokcet 请求方式 |
@Sokcet | 限定为 Sokcet 请求方式 |
@All | 允许所有请求方式(默认) |
其它限定注解 | 说明 |
@Produces | 申明输出内容类型 |
@Consumes | 申明输入内容类型(当输出内容类型未包函 @Consumes,则响应为 415 状态码) |
@Multipart | 显式申明支持 Multipart 输入 |
例:
import org.noear.solon.boot.web.MimeType;
@Mapping("/user")
@Controller
public void DemoController{
@Get
@Mapping("case1")
public void case1(Context ctx, Locale locale , ModelAndView mv){ }
//也可以直接使用 Mapping 的属性进行限定。。。但是没使用注解的好看
@Mapping(path = "case1_2", method = MethodType.GET)
public void case1_2(Context ctx, Locale locale , ModelAndView mv){ }
@Put
@Message
@Mapping("case2")
public void case2(String userName, String nickName){ }
//如果没有输出申明,侧 string 输出默认为 "text/plain"
@Produces(MimeType.APPLICATION_JSON_VALUE)
@Mapping("case3")
public String case3(){
return "{code:1}";
}
////也可以直接使用 Mapping 的属性进行限定。。。但是没使用注解的好看
@Mapping(path= "case3_2", produces=MimeType.APPLICATION_JSON_VALUE))
public String case3_2(){
return "{code:1}";
}
//如果没有输出申明,侧 object 输出默认为 "application/json"
@Mapping("case3_3")
public User case3_3(){
return new User();
}
}
6、输出类型
@Mapping("/user")
@Controller
public void DemoController{
//输出视图与模型,经后端渲染后输出最终格式
@Maping("case1")
public ModelAndView case1(){
ModelAndView mv = new ModelAndView();
mv.put("name", "world");
mv.view("hello.ftl");
return mv;
}
//输出结构体,默认会采用josn格式渲染后输出
@Maping("case2")
public UserModel case2(){
return new UserModel();
}
//输出下载文件
@Maping("case3")
public Object case3(){
return new File(...); //或者 return new DownloadedFile(...);
}
}
7、父类继承支持
@Mapping("user")
public void UserController extends CrudControllerBase<User>{
}
public class CrudControllerBase<T>{
@Post
@Mapping("add")
public void add(T t){
...
}
@Delete
@Mapping("remove")
public void remove(T t){
...
}
}
相关推荐
- 【互联网那些事】高效开发Android App的10个建议
-
假如要GooglePlay上做一个最失败的案例,那最好的秘诀就是界面奇慢无比、耗电、耗内存。接下来就会得到用户的消极评论,最后名声也就臭了。即使你的应用设计精良、创意无限也没用。 耗电或者内存...
- 手机APP开发方式有哪些? 手机app的开发模式有哪三种?
-
微信小程序开发定制_软件开发_APP开发_网站制作-优软软件开发...
- Android开发入门(一):Android系统简介
-
Android系统是Google公司在2008年推出的一款智能移动设备操作系统,通过不断地版本迭代,目前已经推出到Android11版本了。Android系统广泛应用在手机、平板、电视等各种电子设...
- 物联网app开发流程 物联网app开发工具
-
现在随着科技的发展,很多产品都想用一个手机app去显示他的参数数据或者通过手机app去控制它。但是很多人不知道他的流程。今天我就来说下物联网app开发流程。首先需要把物联网app开发流程分2个步骤,一...
- Android开发进阶 | 如何学习 Android Framework?
-
大部分有“如何学习Framework源码”这个疑问的,应该大都是应用层开发。应用层是被Framework层调用执行的,知道自己的代码是怎么被调用的,才能理解程序的本质,理解本质有助于解决遇到的...
- 快速实现APP混合开发(Hybrid App开发)攻略
-
前言:...
- 三个阶段带你了解一款app开发的完整流程
-
第一个阶段需求阶段:1.需求讨论--开发类型、开发平台、具体的产品功能需求、项目预计完成时间、预算2.需求评估--确认合作后评估具体的预算3.界面设计--设计部门进行产品界面设计,形成效果图...
- Android 开发中文引导-应用小部件
-
应用小部件是可以嵌入其它应用(例如主屏幕)并收到定期更新的微型应用视图。这些视图在用户界面中被叫做小部件,并可以用应用小部件提供者发布。可以容纳其他应用部件的应用组件叫做应用部件的宿主(1)。下面的截...
- 手机软件开发从零开始【Android第2篇Hello】
-
Hello,朋友们我们又见面了。上一篇我们讲到了《Android开发环境搭建【Android基础第1篇】》,错过的朋友可以点击文章末尾的“阅读原文”查看。另外需要下载JDK和ADT-bundle工具的...
- 「全栈工程师之梦的开始--安卓开发(二)」开发安卓app
-
在配置好jdk开发环境、安装好开发工具Androidstudio后,我们就可以开始开发安卓app了。首先,我们需要先了解下android的术语。...
- 二、Android界面开发 android 开发
-
学习目标了解Android常用布局了解Android常用控件...
- 如何开发一款APP既快捷也简便 开发一款app的步骤
-
具体较为简单的步骤可以选择用androidstudio开发app1、打开软件,在菜单中选择file-》newproject打开创建向导。2、配置项目,确定各个名称和存放项目的存放路径;Applic...
- 安卓开发中的“Android高手”,需要具备哪些技术?
-
前言成为一名安卓开发者很容易,但是要成为一名“Android高手”却不那么容易;...
- 移动开发(一):使用.NET MAUI开发第一个安卓APP
-
对于工作多年的C#程序员来说,近来想尝试开发一款安卓APP,考虑了很久最终选择使用.NETMAUI这个微软官方的框架来尝试体验开发安卓APP,毕竟是使用VisualStudio开发工具,使用起来也...
- 微软推出PowerApps:零基础开发Win10/iOS/安卓企业应用
-
IT之家讯微软今天面向企业宣布了全新的应用开发解决方案PowerApps,让Windows(包括Win10)、iOS以及安卓应用的开发和分发变得更加简单。PowerApps的用户界面与Office办...
- 一周热门
- 最近发表
- 标签列表
-
- grid 设置 (58)
- 移位运算 (48)
- not specified (45)
- patch补丁 (31)
- 导航栏 (58)
- context xml (46)
- scroll (43)
- element style (30)
- dedecms模版 (53)
- vs打不开 (29)
- nmap (30)
- c 视频教程下载 (33)
- paddleocr (28)
- listview排序 (33)
- firebug 使用 (31)
- transactionmanager (30)
- characterencodingfilter (33)
- getmonth (34)
- commandtimeout (30)
- hibernate教程 (31)
- label换行 (33)
- curlpost (31)
- android studio 3 0 (34)
- android开发视频 (30)
- android应用开发 (31)