Solon

@Mapping 用法说明

这个注解一般是配 @Controller 配合,做请求路径映射用的。

1、支持的路径映射表达式

符号说明示例
**任意字符、不限段数**/user/**
*任意字符/user/*
?可有可无/user/?
/路径片段开始符和间隔符//user
{name}路径变量申明/user/{name}

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

@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(){ }
}

2、参数注入

非请求参数的可注入对象:

类型说明
Context请求上下文
Locale请求的地域信息,国际化时需要
ModelAndView模型与视图对象(自动new一个并注入)
@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){ }
    
    //请求参数(可以是整装的结构体;支持 queryString, form;json,或支持的其它序列化格式Mapping
    @Mapping("case3")
    public void case3(UserModel user){ }
    
    //也可以是混搭的
    @Mapping("case4")
    public void case4(Context ctx, UserModel user, String userName){  }
    
    //文件上传
    @Mapping("case5")
    public void case5(UploadedFile file){ } //注意与 <input type='file' name="file" /> 名字对上
}

3、带注解的参数注入

注解说明
@Param注入请求参数。主要提供默认值等支持
@Header注入请求 header
@Cookie注入请求 cookie
@PathVar注入路径变量(因为框架会自动处理,所以这个只是标识下方便文档生成用)
@Body注入请求体(一般会自动处理。仅在主体的 String, Steam, Map 时才需要)
@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){  }
    
    @Mapping("case4/${id}")
    public void case4(String id){  }
    
    //如果名字不同,才有必要用 @PathVar //否则是自动处理(如上)
    @Mapping("case4_2/${id}")
    public void case4_2(@PathVar("id") String name){  } 
    
    @Mapping("case5")
    public void case5(String name){ }
    
    //如果名字不同,才有必要用 @Param //否则是自动处理(如上)
    @Mapping("case5_2")
    public void case5_2(@Param("id") String name){ } 
    
    //如果要默认值,才有必要用 @Param
    @Mapping("case5_3")
    public void case5_3(@Param(defaultValue="world") String name){ }
}

4、请求方式限定

可以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 所有请求方式
@WebSokcet限定为 WebSokcet 请求方式
@Sokcet限定为 Sokcet 请求方式
@All允许所有请求方式(默认)
其它限定注解说明
@Produces申明输出内容类型
@Consumes申明输入内容类型(当输出内容类型未包函 @Consumes,则响应为 415 状态码)

例:

@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
    @WebSokcet
    @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}";
    }
    
}

5、输出类型

@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(...);
    }
}