img

IT

hello world

九点钟☆方向

记录成长点滴

欢迎来到我的个人博客~

SpringMVC笔记（三） SpringMVC常用注解

| 阅读：次

目录

RequestMapping

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

出现位置：该注解可以注解在方法上，也可以注解在类上

  1. 类上： 请求 URL 的第一级访问目录。此处不写的话，就相当于应用的根目录。 写的话需要以/开头。 它出现的目的是为了使我们的 URL 可以按照模块化管理: 例如： 账户模块： /account/add /account/update /account/delete 订单模块： /order/add /order/update /order/delete
  2. 方法上： 请求 URL 的第二级访问目录。

属性：

path 指定请求路径的URL

value：用于指定请求的 URL。 它和 path 属性的作用是一样的。

method：用于指定请求的方式。

params：用于指定限制请求参数的条件，支持简单的表达式。 要求请求参数的 key 和 value 必须和配置的一样 例如： params = {“accountName”}，表示请求参数必须有 accountName params = {“moeny!=100”}，表示请求参数中 money 不能是 100。 headers：用于指定限制请求消息头的条件。 注意： 以上四个属性只要出现 2 个或以上时，他们的关系是与的关系。

@Controller
public class HelloController {
    @RequestMapping(method = RequestMethod.POST,
                    path="/hello",
                    params = {"hello!=100"},
                    headers = {"Accept"}
                   )
    public String sayHello() {
        return "success";
    }
}
以上示例请求时要求，以POST方式访问，并且请求参数要有accountName=a  请求头中要有Accept信息
http://localhost:8080/hello?accountName=a

RequestParam

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

属性： value： 请求参数中的名称。 required：请求参数中是否必须提供此参数。 默认值： true。表示必须提供，如果不提供将报错。

//jsp 中的代码：
<a href="springmvc/useRequestParam?name=test">requestParam 注解</a>

//控制器中的代码：
@RequestMapping("/useRequestParam")
public String useRequestParam(@RequestParam("name")String username,
                              @RequestParam(value="age",required=false)Integer age){
    System.out.println(username+","+age);
    return "success";
}
结果输出为：test,null	请求参数中没有age，由于配置了required=false，所以程序正常执行，不会报错

RequestBody

作用：用于获取请求体内容。 直接使用得到是 key=value&key=value…结构的数据。get 请求方式不适用。

属性： required：是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false， get 请求得到是 null

//post 请求 jsp 代码：
<form action="springmvc/useRequestBody" method="post">
    用户名称： <input type="text" name="username" ><br/>
    用户密码： <input type="password" name="password" ><br/>
    用户年龄： <input type="text" name="age" ><br/>
    <input type="submit" value="保存">
</form>

//get 请求 jsp 代码：
<a href="springmvc/useRequestBody?body=test">requestBody 注解 get 请求</a>

控制器代码：
@RequestMapping("/useRequestBody")
public String useRequestBody(@RequestBody(required=false) String body){
    System.out.println(body);
    return "success";
}

结果输出为：
Post方式为：username=aaa&password=123&age=23
Get方式为：null

PathVaribale

作用：用于绑定 url 中的占位符。 例如：请求 url 中 /delete/{id}， 这个{id}就是 url 占位符。url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。

属性： value： 用于指定 url 中占位符名称。 required：是否必须提供占位符。

// 代码：
<a href="springmvc/usePathVariable/100">pathVariable 注解</a>

控制器代码：
@RequestMapping("/usePathVariable/{id}")
public String usePathVariable(@PathVariable("id") Integer id){
    System.out.println(id);
    return "success";
}

输出结果为：100

restful 的示例：

/account/1 HTTP GET ： 得到 id = 1 的 account

/account/1 HTTP DELETE： 删除 id = 1 的 account

/account/1 HTTP PUT： 更新 id = 1 的 account

/account HTTP POST： 新增 account

RequestHeader

作用：用于获取请求消息头。

属性： value：提供消息头名称 required：是否必须有此消息头

注：在实际开发中一般不怎么用

//jsp 中代码：
<a href="springmvc/useRequestHeader">获取请求消息头</a>

控制器中代码：
@RequestMapping("/useRequestHeader")
public String useRequestHeader(@RequestHeader(value="Accept-Language",required=false)
                               String requestHeader){
    System.out.println(requestHeader);
    return "success";
}
可以获取请求头中Accept-Language这个参数的信息
输出结果为：zh-CN,zh;q=0.9

CookieValue

作用：用于把指定 cookie 名称的值传入控制器方法参数。

属性： value：指定 cookie 的名称。 required：是否必须有此 cookie。

jsp 中的代码：
<a href="springmvc/useCookieValue">绑定 cookie 的值</a>

控制器中的代码：
@RequestMapping("/useCookieValue")
public String useCookieValue(@CookieValue(value="JSESSIONID",required=false)
                             String cookieValue){
    System.out.println(cookieValue);
    return "success";
}
获取名为JSESSIONID的cookie值赋给形参

ModelAttribute

作用：该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可以修饰有具体返回值的方法。出现在参数上，获取指定的数据给参数赋值。

属性： value：用于获取数据的 key。 key 可以是 POJO 的属性名称，也可以是 map 结构的 key。

应用场景： 当表单提交数据不是完整的实体类数据时，保证没有提交数据的字段使用数据库对象原来的数据。 例如： 我们在编辑一个用户时，用户有一个创建信息字段，该字段的值是不允许被修改的。在提交表单数 据是肯定没有此字段的内容，一旦更新会把该字段内容置为 null，此时就可以使用此注解解决问题。

基于 POJO 属性的基本使用：

jsp 代码：
<a href="springmvc/testModelAttribute?username=test">测试 modelattribute</a>

控制器代码：
/**
* 被 ModelAttribute 修饰的方法
* @param user
*/
@ModelAttribute
public void showModel(User user) {
	System.out.println("执行了 showModel 方法"+user.getUsername());
}
/**
* 接收请求的方法
* @param user
* @return
*/
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user) {
    System.out.println("执行了控制器的方法"+user.getUsername());
    return "success";
}

结果输出为：
执行了 showModel 方法test
执行了控制器的方法test

基于 Map 的应用场景示例 1： ModelAttribute 修饰方法带返回值

需求：修改用户信息，要求用户的密码不能修改

jsp 的代码：
//修改用户信息
<form action="springmvc/updateUser" method="post">
    用户名称： <input type="text" name="username" ><br/>
    用户年龄： <input type="text" name="age" ><br/>
    <input type="submit" value="保存">
</form>

控制的代码：
/**
* 查询数据库中用户信息
* @param user
*/
@ModelAttribute//此注解标注的方法会先执行
public User showModel(String username) {
//可以在此方法中根据用户名查出用户信息，然后将查询出的密码作为user的属性值设置进去，此方法的返回值User将会传到控制器方法的参数中
    User abc = findUserByName(username);
    System.out.println("执行了 showModel 方法"+abc);
    return abc;
}
/**
* 模拟修改用户方法
* @param user
* @return
*/
@RequestMapping("/updateUser")
public String testModelAttribute(User user) {
    System.out.println("控制器中处理请求的方法：修改用户： "+user);
    return "success";
}
/**
* 模拟去数据库查询
* @param username
* @return
*/
private User findUserByName(String username) {
    User user = new User();
    user.setUsername(username);
    user.setAge(19);
    user.setPassword("123456");
    return user;
}

基于 Map 的应用场景示例 1： ModelAttribute 修饰方法不带返回值

需求：修改用户信息，要求用户的密码不能修改

jsp 中的代码：
//修改用户信息
<form action="springmvc/updateUser" method="post">
    用户名称： <input type="text" name="username" ><br/>
    用户年龄： <input type="text" name="age" ><br/>
    <input type="submit" value="保存">
</form>

控制器中的代码：
/**
* 查询数据库中用户信息
* @param user
*/
@ModelAttribute
public void showModel(String username,Map<String,User> map) {
	//模拟去数据库查询
    User user = findUserByName(username);
    System.out.println("执行了 showModel 方法"+user);
    map.put("abc",user);
}
/**
* 模拟修改用户方法
* @param user
* @return
*/
@RequestMapping("/updateUser")
public String testModelAttribute(@ModelAttribute("abc")User user) {
    System.out.println("控制器中处理请求的方法：修改用户： "+user);
    return "success";
}
/**
* 模拟去数据库查询
* @param username
* @return
*/
private User findUserByName(String username) {
    User user = new User();
    user.setUsername(username);
    user.setAge(19);
    user.setPassword("123456");
    return user;
}

SessionAttribute

作用：这个注解可以把Model ModelMap中request作用域的内容复制到session作用域中。用于多次执行控制器方法间的参数共享。

属性：

value：用于指定存入的属性名称

type：用于指定存入的数据类型

//jsp 中的代码：
<a href="springmvc/testPut">存入 SessionAttribute</a>
<hr/>
<a href="springmvc/testGet">取出 SessionAttribute</a>
<hr/>
<a href="springmvc/testClean">清除 SessionAttribute</a>

控制器中的代码：
@Controller("sessionAttributeController")
@RequestMapping("/springmvc")
//@SessionAttributes(types = {Integer.class})将Integer类型的数据复制到session中
@SessionAttributes(value = {"username"})//将名为username的数据复制到session中
public class SessionAttributeController {
    //存入数据
    @RequestMapping("/testPut")
    public String testPut(Model model){
        model.addAttribute("username", "泰斯特");
        model.addAttribute("password","123456");
        model.addAttribute("age", 31);
        //因为配置了SessionAttributes，跳转之前会将SessionAttributes注解中配置的属性值复制到session中
        return "success";
    }
    //取出数据
    @RequestMapping("/testGet")
    public String testGet(ModelMap model){
    	Object username = model.getAttribute("username");
        Object password = model.getAttribute("password");
        Object age = model.getAttribute("age");
        System.out.println(username + "----" + password + "----" + age);
    return "success";
    }
    //清除数据
    @RequestMapping("/testClean")
    public String complete(SessionStatus sessionStatus){
        sessionStatus.setComplete();
        return "success";
    }
}

Model 和 ModelMap

Model 是 spring 提供的一个接口，该接口有一个实现类 ExtendedModelMap 该类继承了 ModelMap，而 ModelMap 就是 LinkedHashMap 子类

使用Model/ModelMap传值

@RequestMapping(value="/list-books")  
private String getAllBooks(Model model){  
    logger.error("/list-books");  
    List<Book> books= bookService.getAllBooks();  
    model.addAttribute("books", books);  
    return "BookList";  
}

@RequestMapping(value="/list-books")  
private String getAllBooks(ModelMap modelMap){  
    logger.error("/list-books");  
    List<Book> books= bookService.getAllBooks();  
    modelMap.addAttribute("books", books);  
    return "BookList";  
}

在jsp页面利${books}即可取出其中的值

打赏一个呗

取消

感谢您的支持，我会继续努力的!

扫码支持
扫码支持
扫码打赏，你说多少就多少

打开支付宝扫一扫，即可进行扫码打赏哦