Solon MVC 的 @Mapping 用法说明
ztj100 2024-12-03 20:03 15 浏览 0 评论
在 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){
...
}
}
- 上一篇:编写 Restful 风格的 API 接口正确姿势
- 下一篇:一文带你掌握CORS
相关推荐
- 使用Python编写Ping监测程序(python 测验)
-
Ping是一种常用的网络诊断工具,它可以测试两台计算机之间的连通性;如果您需要监测某个IP地址的连通情况,可以使用Python编写一个Ping监测程序;本文将介绍如何使用Python编写Ping监测程...
- 批量ping!有了这个小工具,python再也香不了一点
-
号主:老杨丨11年资深网络工程师,更多网工提升干货,请关注公众号:网络工程师俱乐部下午好,我的网工朋友。在咱们网工的日常工作中,经常需要检测多个IP地址的连通性。不知道你是否也有这样的经历:对着电脑屏...
- python之ping主机(python获取ping结果)
-
#coding=utf-8frompythonpingimportpingforiinrange(100,255):ip='192.168.1.'+...
- 网站安全提速秘籍!Nginx配置HTTPS+反向代理实战指南
-
太好了,你直接问到重点场景了:Nginx+HTTPS+反向代理,这个组合是现代Web架构中最常见的一种部署方式。咱们就从理论原理→实操配置→常见问题排查→高级玩法一层层剖开说,...
- Vue开发中使用iframe(vue 使用iframe)
-
内容:iframe全屏显示...
- Vue3项目实践-第五篇(改造登录页-Axios模拟请求数据)
-
本文将介绍以下内容:项目中的public目录和访问静态资源文件的方法使用json文件代替http模拟请求使用Axios直接访问json文件改造登录页,配合Axios进行登录请求,并...
- Vue基础四——Vue-router配置子路由
-
我们上节课初步了解Vue-router的初步知识,也学会了基本的跳转,那我们这节课学习一下子菜单的路由方式,也叫子路由。子路由的情况一般用在一个页面有他的基础模版,然后它下面的页面都隶属于这个模版,只...
- Vue3.0权限管理实现流程【实践】(vue权限管理系统教程)
-
作者:lxcan转发链接:https://segmentfault.com/a/1190000022431839一、整体思路...
- swiper在vue中正确的使用方法(vue中如何使用swiper)
-
swiper是网页中非常强大的一款轮播插件,说是轮播插件都不恰当,因为它能做的事情太多了,swiper在vue下也是能用的,需要依赖专门的vue-swiper插件,因为vue是没有操作dom的逻辑的,...
- Vue怎么实现权限管理?控制到按钮级别的权限怎么做?
-
在Vue项目中实现权限管理,尤其是控制到按钮级别的权限控制,通常包括以下几个方面:一、权限管理的层级划分...
- 【Vue3】保姆级毫无废话的进阶到实战教程 - 01
-
作为一个React、Vue双修选手,在Vue3逐渐稳定下来之后,是时候摸摸Vue3了。Vue3的变化不可谓不大,所以,本系列主要通过对Vue3中的一些BigChanges做...
- Vue3开发极简入门(13):编程式导航路由
-
前面几节文章,写的都是配置路由。但是在实际项目中,下面这种路由导航的写法才是最常用的:比如登录页面,服务端校验成功后,跳转至系统功能页面;通过浏览器输入URL直接进入系统功能页面后,读取本地存储的To...
- vue路由同页面重定向(vue路由重定向到外部url)
-
在Vue中,可以使用路由的重定向功能来实现同页面的重定向。首先,在路由配置文件(通常是`router/index.js`)中,定义一个新的路由,用于重定向到同一个页面。例如,我们可以定义一个名为`Re...
- 那个 Vue 的路由,路由是干什么用的?
-
在Vue里,路由就像“页面导航的指挥官”,专门负责管理页面(组件)的切换和显示逻辑。简单来说,它能让单页应用(SPA)像多页应用一样实现“不同URL对应不同页面”的效果,但整个过程不会刷新网页。一、路...
- Vue3项目投屏功能开发!(vue投票功能)
-
最近接了个大屏项目,产品想在不同的显示器上展示大屏项目不同的页面,做出来的效果图大概长这样...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- idea eval reset (50)
- vue dispatch (70)
- update canceled (42)
- order by asc (53)
- spring gateway (67)
- 简单代码编程 贪吃蛇 (40)
- transforms.resize (33)
- redisson trylock (35)
- 卸载node (35)
- np.reshape (33)
- torch.arange (34)
- npm 源 (35)
- vue3 deep (35)
- win10 ssh (35)
- vue foreach (34)
- idea设置编码为utf8 (35)
- vue 数组添加元素 (34)
- std find (34)
- tablefield注解用途 (35)
- python str转json (34)
- java websocket客户端 (34)
- tensor.view (34)
- java jackson (34)
- vmware17pro最新密钥 (34)
- mysql单表最大数据量 (35)