SpringMVC 常用注解

RequestMapping 注解

作用：是建立请求URL和处理方法之间的对应关系

RequestMapping注解可以作用在方法和类上
1. 作用在类上：第一级的访问目录
2. 作用在方法上：第二级的访问目录
3. 细节：路径可以不编写 / 表示应用的根目录开始
4. 细节：${ pageContext.request.contextPath }也可以省略不写，但是路径上不能写 /
RequestMapping的属性
1. path：指定请求路径的url
2. value：value属性和path属性是一样的
3. mthod：指定该方法的请求方式
4. params：指定限制请求参数的条件
5. headers：发送的请求中必须包含的请求头

RequestParam注解

作用：把请求中的指定名称的参数传递给控制器中的形参赋值

属性
- value：请求参数中的名称
- required：请求参数中是否必须提供此参数，默认值是true，必须提供

/**
 * 接收请求
 */
@RequestMapping(path="/hello") 
public String sayHello(@RequestParam(value="username",required=false) String name) {
    System.out.println("aaaa");
    System.out.println(name);
    return "success";
}

RequestBody注解

作用：用于获取请求体的内容（注意：get方法不可以）

属性
- required：是否必须有请求体，默认值是true

/**
 * 接收请求
 */
@RequestMapping(path="/hello") 
public String sayHello(@RequestBody String body) {
    System.out.println("aaaa");
    System.out.println(body);
    return "success";
}

PathVariable注解

作用：拥有绑定url中的占位符的。例如：url中有/delete/{id}，{id}就是占位符

属性
- value：指定url中的占位符名称
Restful风格的URL
1. 请求路径一样，可以根据不同的请求方式去执行后台的不同方法
2. restful风格的URL优点
  - 结构清晰
  - 符合标准
  - 易于理解
  - 扩展方便

/**
 * 接收请求
 */
@RequestMapping(path="/hello/{id}")
public String sayHello(@PathVariable(value="id") String id) {
    System.out.println(id);
    return "success";
}

RequestHeader注解

作用：获取指定请求头的值

属性
- value：请求头的名称

@RequestMapping(path="/hello/{id}")
public String sayHello(@RequestHeader(value="Accept") String header) {
    System.out.println(header);
    return "success";
}

CookieValue注解

作用：用于获取指定cookie的名称的值

属性
- value：cookie的名称

@RequestMapping(path="/hello/{id}")
public String sayHello(@CookieValue(value="JSESSIONID") String cookieValue) {
    System.out.println(cookieValue);
    return "success";
}

ModelAttribute注解

作用：

1. 出现在方法上：表示当前方法会在控制器方法执行前线执行。
   2. 出现在参数上：获取指定的数据给参数赋值。

应用场景：当提交表单数据不是完整的实体数据时，保证没有提交的字段使用数据库原来的数据。

修饰的方法有返回值

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

/**
 * 修改用户的方法
 */
@RequestMapping(path="/updateUser")
public String updateUser(User user) {
    System.out.println(user);
    return "success";
}

修饰的方法没有返回值

/**
 * 作用在方法，先执行
 */
@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);
}

/**
 * 修改用户的方法
 */
@RequestMapping(path="/updateUser")
public String updateUser(@ModelAttribute(value="abc") User user) {
    System.out.println(user);
    return "success";
}

SessionAttributes注解

作用：用于多次执行控制器方法间的参数共享

属性
- value：指定存入属性的名称

@Controller
@RequestMapping(path="/user")
// 把数据存入到session域对象中
@SessionAttributes(value= {"username","password","age"},types={String.class,Integer.class})
public class HelloController {

    /** 向session中存入值 */
    @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中获取值 */
    @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";
    }
    
    /** 清除值 */
    @RequestMapping(path="/delete")
    public String delete(SessionStatus status) {
        status.setComplete();
        return "success";
    }

}

参考文献

黑马 Java

Good Good Write Bug, Day Day Up