SpringMVC篇（一）Controller层常用注解

Controller层

控制层，负责处理由DispatcherServlet分发的请求，把用户请求的数据经过业务处理层处理之后封装成一个Model ，然后再把该Model 返回给对应的View 进行展示。

@Controller

将类标识为一个Spring组件，使Spring容器能够扫描到该类并加入容器进行管理。

@RequestMapping

RequestMapping使用须知

@RequestMapping 用法详解之地址映射

注解属性

1. value， method；

   value： 指定请求的实际地址，指定的地址可以是URI Template 模式（后面将会说明）；

   method： 指定请求的method类型， GET、POST、PUT、DELETE等；

2. consumes，produces；
   consumes： 指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;

   produces: 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；

3. params，headers；
   params： 指定request中必须包含某些参数值是，才让该方法处理。

   headers： 指定request中必须包含某些指定的header值，才能让该方法处理请求。

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping("one")
public class TestController {
    @RequestMapping("two")
    public String test(){
        return "index";
    }
}

//如上注解后，映射地址为：http://localhost:8080/xx/one/two

SpringMVC新版本，@RequestMapping的作用可以分解为以下注解，省略method属性。

• @GetMapping
• @PostMapping
• @PutMapping
• @DeleteMapping
• @PatchMapping

@Autowired

@Autowired用法详解

Spring注解@Resource和@Autowired区别对比

标注在成员变量中，实现变量的自动装配。

你可以在项目中的任意类中自动装配变量。

在启动spring IoC时，容器自动装载了一个AutowiredAnnotationBeanPostProcessor后置处理器，当容器扫描到@Autowied、@Resource或@Inject时，就会在IoC容器自动查找需要的bean，并装配给该对象的属性。

@Autowired
UserService userService;

@Autowired
UserDao userDao;

• @Aautowired : Spring提供的注解.
• @Inject : JSR-330提供的注解
• @Resource : JSR-250提供的注解

@RequestParam

@RequestParam注解可以接收请求参数值。

GET和POST请求传的参数会自动转换赋值到@RequestParam 所注解的变量上。

@RequestMapping(value="/hello", method = RequestMethod.GET)
public String hello(@RequestParam(value="username") String userName,
                    @RequestParam(value="usernick") String userNick){
    System.out.println("username: " + userName);
    System.out.println("usernick: " + userNick);
    return "hello";
}

对比不使用@RequestParam，手动赋值的方法：

@RequestMapping(value="/hello", method = RequestMethod.GET)
public String hello(String username, HttpServletRequest request){
    System.out.println("username: " + username);
    String usernick = request.getParameter("usernick");
    System.out.println("usernick: " + usernick);
    return "hello";
}

还有一种不使用@RequestParam也能自动赋值的方法，要求请求参数名与变量名一致。

@RequestMapping(value="/hello", method = RequestMethod.GET)
public String hello(String username, String usernick){
    System.out.println("username: " + username);
    System.out.println("usernick: " + usernick);
    return "hello";
}

@RequestParam有以下属性：

• value
  • 指定要绑定的参数名
• required
  • true 表示该参数必须传
  • false 表示该参数可以不传
• defaultValue
  • 当该参数未传时，使用指定的默认值
• name
  • value的别名，与value作用相同

@PathVariable

@PathVariable注解可以接收URI占位符的值。

@GetMapping("/{id}")
public String findUserById(@PathVariable("id") Integer id) {
    User user = userService.findUserById(id);
    System.out.println(user);
    return "userInfo";
}

@RequestBody

@RequestBody的使用

@RequestBody注解可以接收json格式的数据，并将其转换成对应的数据类型。

@RequestBody可以标识在参数上。

@PostMapping("/save")
public void saveUserByJson(@RequestBody User user) throws IOException {
    System.out.println(user);
    userService.saveUser(user.getUserName(), user.getEmail());
}

@ResponseBody

@ResponseBody注解可以将Controller的方法返回对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或XML。

需要注意的是，使用此注解后不会再走视图解析器，而是直接将数据写入到输入流中。

@ResponseBody可以标识在类、方法上，作用范围不同。

@RequestMapping("/login")
@ResponseBody
public User login(User user){
	return user;
}

对比不使用@ResponseBody的方法，通过response的PrintWriter类：

@RequestMapping("/login")
public void login(User user, HttpServletResponse response){
    response.getWriter.write(JSONObject.fromObject(user).toString());
}

@RequestHeader

@RequestHeader注解可以获取请求头信息，让方法参数绑定请求头中指定value的key。

@RequestMapping("/testRequestHeader")
public String testRequestHeader(@RequestHeader(value = "key", required = true, defaultValue = "-999") String key,
                                @RequestHeader(value = "Accept-Encoding") String ae) {
    System.out.println("testRequestHeader, key:" + key + ", Accept-Encoding:" + ae);
    return "SUCCESS";
}

@CookieValue

@CookieValue可获取请求中的Cookie值，让方法参数绑定某个cookie值。

@RequestMapping("/testCookieValue")
public String testCookieValue(@CookieValue(value = "JSESSIONID", required = true, defaultValue = "-999") String jsessionId) {
    System.out.println("testCookieValue, JSESSIONID:" + jsessionId );
    return SUCCESS;
}

@ModelAttribute

该Controller类所有方法执行前，先调用此@ModelAttribute方法，可用于注解和方法参数中。

@ModelAttribute注解用于将请求参数绑定到Model对象。

允许我们在调用目标方法前操纵模型数据。

@ModelAttribute注解用法详解

SpringMVC常用注解之RequestMapping及ModelAttribute的使用

SpringMvc中Model、ModelMap、ModelAndView理解和具体使用总结⭐

1. 使用方法一，注解void方法。

   @Controller
   @RequestMapping(value="/")
   public class TestModelAttributeController {
       
   	@ModelAttribute
   	public void user(@RequestParam("username") String username,
                        @RequestParam("pwd") String pwd,
                        Model model) {
   		 model.addAttribute("username", username);
   		 model.addAttribute("pwd", pwd);
   	}
       
   	@RequestMapping(value="/result")
   	public String login(Model model) {
   		//如果测试成功，控制台输出true
   		System.out.println(model.containsAttribute("username"));
   	    System.out.println(model.containsAttribute("pwd"));
   		return "result"; 
   	}
   	
   }
   

2. 使用方法二，注解返回具体类的方法。

   @Controller
   @RequestMapping(value="/")
   public class TestModelAttributeController{
   	
       /*
       * 返回的是username的值
       * 相当于model.addAttribute("username", username);
       */
   	@ModelAttribute(value="username") //value作为attribute属性名
   	public String userModel(@RequestParam("username") String username) {
   		return username; //返回值作为attribute属性的值
   	}
       
   	@RequestMapping(value="result")
   	public String login(Model model) {
   		model.containsAttribute("username");
   		return "result";
   	}
       
   }
   
   

@SessionAttributes

默认情况下Spring MVC将模型中的数据存储到request域中。当一个请求结束后，数据就失效了。如果要跨页面使用。那么需要使用到session。而@SessionAttributes注解就可以使得模型Model中的数据存储一份到session域中。

允许我们有选择性的指定Model中的哪些属性需要转存到HttpSession对象当中。

@SessionAttributes注解可以将指定的Model中的键值对存储到session域中。

@SessionAttributes只能标识在类上。

将Model中的user转存在HttpSession中。

@Controller
@RequestMapping("/model")
@SessionAttributes("user")
public class ModelController {

    @ModelAttribute("user")
    public User initUser(){
        User user = new User();
        user.setName("default");
        return user;
    }

    @RequestMapping("/parameter")
    public String parameter(
            @ModelAttribute("user") User user
    ) {

        return "index";
    }

}

@RestController

@RestController相当于@Controller+@ResponseBody。

即标明当前类是一个Controller组件，又标明该Controller所有方法返回数据而不是视图。

传统的前后端不分离架构是后端返回视图，前后端分离架构是后端返回数据，前端视图加载数据。

@RestController VS @Controller