springMVC常用注解

咻pur慢 2020-02-15

RequestParam:

作用:
    把请求中指定名称的参数给控制器中的形参赋值。还可以解决请求参数名称和控制器方法参数不一致不能封装的问题
  属性:
    value:请求参数中的名称。
    required:请求参数中是否必须提供此参数。默认值:true。表示必须提供,如果不提供将报错。

@RequestMapping("/useRequestParam")
public String useRequestParam(@RequestParam("name")String username, @RequestParam(name="age",required=false)Integer age){
  System.out.println(username+","+age);
  return "success";
}

RequestBody:

作用:
    用于获取请求体内容。直接使用得到的是 key=value&key=value...结构的数据。
    get 请求(没有请求体)方式不适用。

  接收的请求参数是 json 格式数据时需要使用
  属性:
    required:是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false,get 请求得到是 null。

@RequestMapping("/useRequestBody")
public String useRequestBody(@RequestBody(required=false) String body){
  System.out.println(body);
  return "success";
}

PathVaribale:

作用:
    用于绑定 url 中的占位符。例如:请求 url 中 /delete/{id},这个 {id} 就是 url 占位符。
    url 支持占位符是 spring3.0 之后加入的,是 springmvc 支持 rest 风格 URL 的一个重要标志。
  属性:
    value:用于指定 url 中占位符名称。
    required:是否必须提供占位符。

springMVC常用注解

@RequestMapping("/usePathVariable/{id}")
public String usePathVariable(@PathVariable("id") Integer id){
  System.out.println(id);
  return "success";
}

RequestHeader:

作用:
    用于获取请求消息头。
  属性:
    value:提供消息头名称
    required:是否必须有此消息头

@RequestMapping("/useRequestHeader")
public String useRequestHeader(@RequestHeader(value="Accept-Language", required=false)String requestHeader){
  System.out.println(requestHeader);
  return "success";
}

CookieValue:

作用:
    用于把指定 cookie 名称的值传入控制器方法参数。
  属性:
    value:指定 cookie 的名称。
    required:是否必须有此 cookie。

@RequestMapping("/useCookieValue")
public String useCookieValue(@CookieValue(value="JSESSIONID",required=false)String cookieValue){
  System.out.println(cookieValue);
  return "success";
}

ModelAttribute:

作用:
    该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。
    出现在方法上,表示当前方法会在控制器的方法执行之前,先执行。它可以修饰没有返回值的方法,也可以修饰有具体返回值的方法。
    出现在参数上,获取指定的数据给参数赋值。
  属性:
    value:用于获取数据的 key。key 可以是 POJO 的属性名称,也可以是 map 结构的 key。
  应用场景:
    当表单提交数据不是完整的实体类数据时,保证没有提交数据的字段使用数据库对象原来的数据。
    例如:
      我们在编辑一个用户时,用户有一个创建信息字段,该字段的值是不允许被修改的。

    在提交表单数据是肯定没有此字段的内容,一旦更新会把该字段内容置为 null,此时就可以使用此注解解决问题。

具体用法:

  1. 修饰的方法有返回值

/**
* 作用在方法,先执行
* @param name
* @return
*/
@ModelAttribute
public User showUser(String name) {
  System.out.println("showUser执行了...");
  // 模拟从数据库中查询对象
  User user = new User();
  user.setName("哈哈");
  user.setPassword("123");
  user.setMoney(100d);
  return user;
}
/**
* 修改用户的方法
* @param cookieValue
* @return
*/
@RequestMapping(path="/updateUser")
public String updateUser(User user) {
  System.out.println(user);
  return "success";
}

  2. 修饰的方法没有返回值

/**
* 作用在方法,先执行
* @param name
* @return
*/
@ModelAttribute
public void showUser(String name,Map<String, User> map) {
  System.out.println("showUser执行了...");
  // 模拟从数据库中查询对象
  User user = new User();
  user.setName("哈哈");
  user.setPassword("123");
  user.setMoney(100d);
  map.put("abc", user);
}
/**
* 修改用户的方法
* @param cookieValue
* @return
*/@RequestMapping(path="/updateUser")
public String updateUser(@ModelAttribute(value="abc") User user) {
  System.out.println(user);
  return "success";
}

SessionAttributes:

作用:
    用于多次执行控制器方法间的参数共享。
  属性:
    value:用于指定存入的属性名称
    type:用于指定存入的数据类型。

@Controller
@RequestMapping(path="/user")
@SessionAttributes(value= {"username","password","age"},types=
  {String.class,Integer.class}) // 把数据存入到session域对象中
public class HelloController {
  /**
  * 向session中存入值
  * @return
  */
  @RequestMapping(path="/save")
  public String save(Model model) {
    System.out.println("向session域中保存数据");
    model.addAttribute("username", "root");
    model.addAttribute("password", "123");
    model.addAttribute("age", 20);
    return "success";
  }
  /**
  * 从session中获取值
  * @return
  */
  @RequestMapping(path="/find")
  public String find(ModelMap modelMap) {
    String username = (String) modelMap.get("username");
    String password = (String) modelMap.get("password");
    Integer age = (Integer) modelMap.get("age");
    System.out.println(username + " : "+password +" : "+age);
    return "success";
  }
  /**
  * 清除值
  * @return
  */
  @RequestMapping(path="/delete")
  public String delete(SessionStatus status) {
    status.setComplete();
    return "success";
  }
}

相关推荐