百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 文章教程 > 正文

Solon MVC 的 @Mapping 用法说明

xsobi 2024-12-06 20:28 24 浏览

在 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}

路径组合(控制器映射与动作映射)及应用示例:

Bash
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() 接口统一获取。

Bash
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){
        ...
    }
}

相关推荐

Web前端和后端有什么区别(上)

关于Web前端与后端之间有什么区别呢,下面有小编带你了解一下,相信看完本文你会有新的理解。一.定义不同一般来说,我们把网站分为前端和后端。前端主要负责页面展示,后端是业务逻辑的实现。1、Web前端...

前端开发新手入门:Web开发工具有哪些?

好的开发工具不仅可以节约时间,更能节约开发成本。作为Web时代最常用的前端开发语言,Web前端受到各大企业的重视,很多零基础的人都想学习Web前端开发,下面千锋广州小编就来给大家介绍一下常见的Web开...

自己动手写的一套UI界面框架,有兴趣的可以看看

从事web开发这么多年了,UI一直是我的痛,第一个用的是Ext,授权费用高暂且不说,那个前端框架实在是臃肿,肿到要用Chrome浏览器才顺畅。然后就是easyUI,比ext是轻巧,但是商用也一样要授权...

十大初学者须知的web前端开发框架,知道几个

近几年随着jQuery、Ext以及CSS3的发展,以Bootstrap为代表的前端开发框架如雨后春笋般挤入视野,可谓应接不暇。不论是桌面浏览器端还是移动端都涌现出很多优秀的框架,极大丰富了...

同事给我埋了个坑:Insert into select语句把生产服务器炸了

前言Insertintoselect请慎用。这天xxx接到一个需求,需要将表A的数据迁移到表B中去做一个备份。本想通过程序先查询查出来然后批量插入。但xxx觉得这样有点慢,需要耗费大量的网络I/O...

MySQL 导出数据

MySQL中你可以使用SELECT...INTOOUTFILE语句来简单的导出数据到文本文件上。使用SELECT...INTOOUTFILE语句导出数据以下实例中我们将数据表w3csch...

VBA中if then 语句和select case实例比较

实例比较分析“If…then…”语句和“selectcase对象caseis条件1执行1caseis条件n执行n或caseelse执行Endeslect”的区别...

Excel高级教程:VBA Select Case语句用法与案例教程

当需要依次检测一个表达式的多个值,并根据每个值来执行不同的操作时,SelectCase可以提供更清晰的结构。下面我们一起来看看VBASelectCase语句用法与案例教程吧。...

Excel VBA流程图解之Select Case语句 多分支选择的最佳选择

上一篇,我们画了一个IF的流程图,显然有些场景用IF写起来比较繁琐,比如常用与分数段判断,时间段,税率,提成比例等问题,IF每个条件里都要写判断的对象,很是麻烦,那么SelectCase就是为此而生...

真刺激,用了Insert into select语句,差点直接被劝退

作者:不一样的科技宅https://juejin.im/post/5e670f0151882549274a65efInsertintoselect请慎用,同事因为使用了Insertinto...

shell脚本中使用select循环语句创建交互式菜单

在shell脚本中需要创建一个交互式菜单时,可以使用while语句或者select语句;不过两者存在区别,接下来,体验一下两个语句的不同之处;使用while语句创建交互式菜单...

2025年SQL新手避坑指南:SELECT语句的正确打开方式,效率翻倍!

为什么数据库运行顺序必须死记硬背?...

面试官:select语句和update语句分别是怎么执行的?

最近有粉丝面试互联网公司被问到:你知道select语句和update语句分别是怎么执行的吗?...

DevExpress Demo示例展示:媲美Excel的电子表格控件

今天介绍一个很强大的电子表格(Spreadsheet)控件:DevExpressSpreadsheetforASP.NETMVC。它是一个仿ExcelUI的电子表格控件,可完全无障碍读写...

C#上传大型视频文件到服务器,解决方案

后端用了ASP.NET,.NETCore.NETMVC,IDE用了VisualStudio2010,VisualStudio2013,VisualStudio2022前端用了HTML,...