SpringMVC中几个常用注解的用法

一、@Controller

        以前在编写Controller方法的时候，需要开发者自定义一个Controller类实现Controller接口，实现handleRequest方法返回ModelAndView。并且需要在Spring配置文件中配置Handle，将某个接口与自定义Controller类做映射。
        这么做有个复杂的地方在于，一个自定义的Controller类智能处理一个单一请求。而在采用@Contoller注解的方式，可以使接口的定义更加简单，将@Controller标记在某个类上，配合@RequestMapping注解，可以在一个类中定义多个接口，这样使用起来更加灵活。
    被@Controller标记的类实际上就是个SpringMVC Controller对象，它是一个控制器类，而@Controller注解在org.springframework.stereotype包下，其中被@RequestMapping标记的方法会被分发处理器扫描识别，将不同的请求分发到对应的接口上。

       扫描@Controller：<context:component-scan base-package="com.sunhui.ssm.controller"/>

       base-package：包的路径。意思就是，启动了报扫描功能，将com.sunhui.ssm.controller这个包下以及子包下的所有类扫描一遍，将标记有@Controller、@Service、@repository、@Component等注解的类注入到IOC容器中，作为Spring的Bean来管理。

        这样，Spring就能找到Controller类，通过@RequestMapping注解处理对应的请求。

---

二、@RequestMapping

当我们需要在控制类的内部为每一个动作开发相应的处理方法。要让Spring知道用哪一种方法来处理它的动作，需要使用import org.springframework.web.bind.annotation.RequestMapping注解类型来映射uri与方法。

1、@RequestMapping注解修饰类

@Controller
@RequestMapping(value="/Items")
public class ItemsController {
    ......
}

2、@RequestMapping注解修饰方法 

@Controller
@RequestMapping(value="/Items")
public class ItemsController {
	
	@Autowired
	private ItemsService itemsService ;
	
	@RequestMapping(value="/queryItems")
	public ModelAndView itemsList(HttpServletRequest request,ItemsQueryVo itemsQueryVo) {
        ......
    }
}

       类上的@RequestMapping中的value值相当于web应用的根目录，而方法上的@RequestMapping中的value值相当于web应用的子目录，这时候请求的URL的值应该是：Items/queryItems

3、@RequestMapping注解的请求方式

POST请求：

	/*
	 * 使用method属性来指定请求方式为POST
	 */
	@RequestMapping(value="/testmethod",method=RequestMethod.POST)
	public String testMethod() {
		return SUCCESS;
	}

POST和GET请求：

	/*
	 * 使用method属性来指定请求方式为POST和GET 
	 */
	@RequestMapping(value="/testmethod",method={RequestMethod.POST,RequestMethod.GET})
	public String testMethod() {
		return SUCCESS;
	}

---

三、Param

1、使用@Param注解来声明参数时，在mapper.xml中的占位符使用 #{} 或 ${} 的方式都可以；不使用@Param注解来声明参数时，必须使用使用 #{}方式，如果使用 ${} 的方式，会报错。

1）#{}

    @Select("select column from table where userid = #{userid} ")
    public int selectColumn(int userid);

2）${}

    @Select("select column from table where userid = ${userid} ")
    public int selectColumn(@Param("userid") int userid);

2、不使用@Param注解时，参数只能有一个，并且是Javabean。在SQL语句里可以引用JavaBean的属性，而且只能引用JavaBean的属性。

例：

    // 这里的id一定是user的属性
    @Select("SELECT * from User where id = ${id}")
    List selectUserById(User user);

---

四、@RequestParam

@RequestParam注解：在处理方法入参除使用@RequestParam可以把请求参数传递给请求方法。

        value：参数名

        required：是否必须。默认为true，表示请求参数中必须包含对应的参数，若不存在，将抛出404错误码。

        defaultValue：默认值。当没有传递参数是使用该值。

例1：

@RequestMapping("/items")
public String queryUserName(@RequestParam(value="username") String UserName)

解释：

        @RequestParam注解用于处理请求参数username和处理方法的入参UserName名称不同，从而形成了二者的对应关系，即将username的值传递给UserName。

        这种情况要求浏览器url中必须带有参数，即localhost:8080/items/username=?，如果不带参数username则会报错。

例2：

public String requestParam(@RequestParam(value="username", required=true, defaultValue="zhangsan") String username)   

解释：

        required=true，表示必须传入参数，但是由于设置了defaultValue="zhangsan"，这就说明传入参数值时正常接收，如果不传入参数值，此时为默认参数值为zhangsan。

注：如果不用@RequestParam注解，则传入的参数必须和形参一致。

使用场景：

这个注解一般在工作中，会用在组合查询多个对象，比如跟据姓名模糊查询和性别组合查询筛选学生，就会发送POST请求，后台使用RequestParam接收

优缺点：

• 优点：支持常用多种请求方式，请求参数可以封装在请求体中较为安全
• 缺点：id暴露在url上，对于不方便泄露ID的值请求，最好不要使用。只支持Get方式，请求方式有局限性

---

五、PathVariable

@PathVariable注解映射URL绑定的占位符

• PathVariable是路径变量的意思，这个注解主要作用在请求URL路径上的数据绑定，默认传递数值写在URL上，SpringMVC就可以获取到。带占位符的 URL 是 Spring3.0 新增的功能，该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义
• 通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中：URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。
• 如果要接收多个路径变量，则需要声明多个@PathVariable变量

示例： 
- /order/1 HTTP GET ：      得到 id = 1 的 order 
- /order/1 HTTP DELETE：删除 id = 1的 order 
- /order/1 HTTP PUT：       更新id = 1的 order 
- /order HTTP POST：       新增 order

@RequestMapping("/Student")
@RestController
public class DataBindController {
    @Autowired
    private StudentService studentService;
    @GetMapping("/getStudent/{id}")
    public Student getStudentById(@PathVariable Integer id){
        Student student = studentService.getStudentById(id);
        return student;
    }
}

使用场景：

这个注解一般在工作中，会用在单个对象的查询上，比如：根据ID值查询学生信息，就会在Postman发送GET请求，后台使用@PathVariable接收

优缺点： 

• 优点：适合接收简单类型的数据绑定，如int，string这两个常用
• 缺点：id暴露在url上，对于不方便泄露ID的值请求，最好不要使用。只支持Get方式，请求方式有局限性，不支持复杂数据类型，自定义数据类型

---

注：@PathVariable @RequestParam @RequestBody 

注解	请求参数位置	请求方式	支持的Content-Type	请求示例
@PathVariable	Url	Get	Get请求没有Content-Type	/students/1
@RequestParam	Url和Body	Get/Post/Put/Delete/Patch	form-data，x-www-form-urlencoded	/students?name=zs&age=23
@RequestBody	Body	Post/Put/Delete/Patch	application/json	{"id":1,"name":"zs","age":23}