spring笔记02（web类注解）

参考文章：
https://aflyun.blog.youkuaiyun.com/article/details/76299467
https://blog.youkuaiyun.com/leo187/article/details/107848688

RestController与Controller

参考文章：https://www.zhenyuke.com/info/49566155/

@RestController 在 Spring MVC 中就是 @Controller 和 @ResponseBody 注解的集合。

@RestController 注解是从 Spring 4.0 版本开始添加进来的，主要用于更加方便的构建 RESTful Web 服务。@ResponseBody注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。使用此注解此次请求将不再走视图处理器，而是直接将此响应结果写入到输入流中，其效果等同于使用response对象输出指定格式的数据。

在 RESTful 的服务中，我们大部分情况是使用 JSON 为返回数据的，所以你可以直接使用 @RestController 替换掉 @Controller 和 @ResponseBody。

RequestMapping

对应get/post方法，对应有@GetMapping/@PostMapping注解

https://developer.aliyun.com/article/651661

代码示例

@RestController
@RequestMapping("/pay")
public class PayController extends LogBase {

    @Autowired
    private PayService payService;

    @PostMapping("/createOrder")
    public ResponseEntity<CreateOrderRes> createOrder(CreateOrderParam param, HttpServletRequest request, HttpServletResponse response){
        param.checkParam();//检查参数合法性
        return payService.createOrder(param , request);
    }

等同于

@RestController
public class PayController extends LogBase {

    @Autowired
    private PayService payService;

    @PostMapping("/pay/createOrder")
    public ResponseEntity<CreateOrderRes> createOrder(CreateOrderParam param, HttpServletRequest request, HttpServletResponse response){
        param.checkParam();//检查参数合法性
        return payService.createOrder(param , request);
    }

@RequestBody与@RequestParam

@RequestParam

https://www.cnblogs.com/tomingto/p/11377138.html

@RequestParam （org.springframework.web.bind.annotation.RequestParam）用于将指定的请求参数赋值给方法中的形参。

有三个属性：

1. value：请求参数名（必须配置）

2. required：是否必需，默认为 true，即 请求中必须包含该参数，如果没有包含，将会抛出异常（可选配置）

3. defaultValue：默认值，如果设置了该值，required 将自动设为 false，无论你是否配置了required，配置了什么值，都是 false（可选配置）

4. 为演示效果，首先需要创建一个测试控制类，然后创建一个测试方法，如图所示，方法里添加一个参数，此时方法参数没有添加注解。通过idea工具启动web项目，然后通过浏览器访问测试效果
   不带参数则获取的参数为null，但页面可以正常显示，请求可以正常的执行。

带上参数之后，参数可以正常的获取并打印出来了

2. 下面来对比下添加注解的效果，但只是添加@RequestParam，没有带任何的注解设置参数。再次通过浏览器访问查看效果
   此时带上userName参数页面可以正常显示并打印出结果值，但如图所示

不带参数的时候，页面报错，返回400，并提示userName不存在

3. 当然这样的限制是可以选择的，@RequestParam里添加required=false来关闭必须参数的限制，这样就和第一种不带注解的效果一样了
   
4. @RequestParam还可以在参数为空的情况下，为我们设置一个参数的默认值，如图所示，可以看出来，没有参数的情况下，获取到的就是默认值
   
5. 默认参数的key名称是方法里的参数名称，但通过@RequestParam可以自定义另外一个，因为在某些条件下，方法名称固定下来不可以修改了，但请求的参数又需要通过另外一个参数key名称来传递，这样就可以通过这样的方式来实现

@RequestBody

1、@requestBody注解常用来处理content-type不是默认的application/x-www-form-urlcoded编码的内容，比如说：application/json或者是application/xml等。一般情况下来说常用其来处理application/json类型。@RequestBody接受的是一个json格式的字符串，一定是一个字符串。

2、通过@requestBody可以将请求体中的JSON字符串绑定到相应的bean上，当然，也可以将其分别绑定到对应的字符串上。例如说以下情况：

　　　　$.ajax({
　　　　　　　　url:"/login",
　　　　　　　　type:"POST",
　　　　　　　　data:'{"userName":"admin","pwd","admin123"}',
　　　　　　　　content-type:"application/json charset=utf-8",
　　　　　　　　success:function(data){
　　　　　　　　　　alert("request success ! ");
　　　　　　　　}
　　　　});

@requestMapping("/login")
public void login(@RequestParam(value= "userName") String userName,@RequestParam(value= "pwd") String pwd){
	System.out.println(userName+" ："+pwd);
}

这种情况是将JSON字符串中的两个变量的值分别赋予了两个字符串，但是呢假如我有一个User类，拥有如下字段：

String userName;
String pwd;

那么上述接口可以改为以下形式：

@requestMapping("/login")
public void login(@RequestBody User user){
	System.out.println(user.getUserName()+":"+user.getPwd());
}

这种形式会将JSON字符串中的值赋予user中对应的属性上。需要注意的是，JSON字符串中的key必须对应user中的属性名，否则是请求不过去的。

总结:

1. @RequestBody接受的是一个json格式的字符串，一定是一个json对象字符串。
2. 在使用springmvc的做项目时,将JSON字符串和JSON对象混淆了。
3. @RequestParam接受单个参数，参数位置位于链接后。@RequestBody接受JSON对象字符串，参数位置位于请求体。

其他

@RequestBody与@RequestParam()可以同时使用

@RequestParam接收的是key-value里面的参数，可以有多个，对应不同参数

@RequestBody 接收的是请求体里面的数据，映射成一个对象；所以最多只能有一个该注解。如果请求参数体里的参数信息比较多，包含了多个实体的对应属性，那么我们可以借助JSONObject来接收，再利用json来取出指定属性。

public void login(@RequestBody JSONObject json){
	
}