SpringMVC--常用注解

最新推荐文章于 2023-04-27 10:43:37 发布

龙源lll

最新推荐文章于 2023-04-27 10:43:37 发布

阅读量541

点赞数 1

分类专栏： SpringMVC 文章标签： 1024程序员节 spring

本文链接：https://blog.csdn.net/Lzy410992/article/details/109254703

版权

SpringMVC 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

SpringMVC目录：

SpringMVC–快速入门
SpringMVC–常用注解
SpringMVC–请求参数绑定
SpringMVC–返回不同类型的数据
SpringMVC–文件上传
SpringMVC–异常处理
SpringMVC–配置拦截器
Spring+SpringMVC+Mybatis框架整合（SSM整合）

RequestMapping 注解

@RequestMapping：映射请求和处理方法，建立请求URL和处理方法之间的对应关系，可以使用@RequestMapping注解作用在方法或类上，RequestMapping的路径可以不编写 / 表示应用的根目录开始。 RequestMapping的属性：

path：指定请求路径的url
value： value属性和path属性是一样的
mthod：指定该方法的请求方式
params：指定限制请求参数的条件
headers：发送的请求中必须包含的请求头

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping { }

当注解出现在类上，请求的是URL的第一级访问目录。此处不写的话，就相当于应用的根目录，写的话需要以/开头，它出现的目的是为了使我们的 URL 可以按照模块化管理。当注解写在方法上，请求的是 URL 的第二级访问目录。

@Controller("userController")
@RequestMapping("/user")
public class UserController {
	@RequestMapping("/findUser")
	public String findUser() {
		System.out.println("查询了用户。。。。");
		return "success"; 
		} 
	}
    .......	
}

<%@ page language="java" contentType="text/html; charset=UTF-8" 
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd"> <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>requestmapping 的使用</title>
</head> 
<body>
	<!-- 第一种访问方式 --> <a href="${pageContext.request.contextPath}/user/findUser">查询用户
	</a><br/>
	<!-- 第二种访问方式 --> <a href="user/findUser">查询用户</a>
</body>
</html>

method 属性：指定请求的method类型， GET、POST、PUT、DELETE…
控制器代码：

/**
* 保存账户
* @return
*/
@RequestMapping(value="/saveUser",method=RequestMethod.POST)
//方法只支持post方式请求，当使用get请求时，提示错误信息405
public String saveUser() {
	System.out.println("保存了用户");
	return "success"; 
}

jsp 代码：

<form action="user/saveUser" method="post"> <input type="submit" value="保存账户"></form>

params 属性：指定request中必须包含某些参数值是，用该方法才能处理请求

控制器的代码：

/**
* 删除账户
* @return
*/
@RequestMapping(value="/removeUser",params= {"username","password=123456"})
public String removeAccount() {
	System.out.println("删除了用户");
	return "success"; 
}

jsp 中的代码：

<!-- 请求参数的示例 --> 
<a href="user/removeUser?userName=zhangsan&password=123456">删除用户</a>

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

// 表示只接收本机发来的请求
@RequestMapping(path = "/login", headers="Host=localhost:8080")
public String login() {
	return "success";
}

RequestParam注解

@RequestParam 注解用于将指定的请求参数赋值给方法中的形参，定义在方法参数中
属性：value：请求参数中的名称、required：请求参数中是否必须提供此参数，默认值：true。表示必须提供，如果不提供将报错。

jsp页面：

<a href="anno/testRequestParam?name=li">RequestParam</a>

控制器代码：

/**
 * @Author: Ly
 * @Date: 2020-09-23 08:25
 */
@Controller
@RequestMapping("/anno")
public class AnnoController {
    @RequestMapping("/testRequestParam")
    public String testRequestParam(@RequestParam(name = "name") String username,@RequestParam(value = "age",required=false) Integer age){
        System.out.println("执行了...");
        System.out.println("用户名是："+username+",年龄："+age);
        return "success";
    }
}

RequestBody注解

@RequestBody用于获取请求体内容。直接使用得到是 key=value&key=value…结构的数据，get 请求方式不适用。
属性：required：是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false，get 请求得到是 null。

post 请求 jsp 代码：
<!-- request body 注解 --> 
<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>

控制器代码：

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

post 请求获得结果，get 请求运行结果为null；

PathVaribale注解

@PathVaribale用于绑定 url 中的占位符。Spring MVC的路径变量是在URL项目名后，问号（?）之前所包含的信息，路径变量获取通过在控制器映射路径中通过{路径映射名}进行指定，在形参上通过@PathVariable(“id名”)指定获取路径变量，可以通过多个路径变量请求参数。
属性：value：用于指定 url 中占位符名称，required：是否必须提供占位符。

jsp 代码：

<!-- PathVariable 注解 --> 
<a href="springmvc/usePathVariable/100">pathVariable 注解</a>

控制器代码：

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

运行结果：100

RequestHeader注解

@RequestHeader用于获取请求消息头
属性：value：提供消息头名称required：是否必须有此消息头，注：在实际开发中一般不怎么用。

jsp 中代码：

<!-- RequestHeader 注解 --> 
<a href="springmvc/useRequestHeader">获取请求消息头</a>

控制器中代码：

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

运行结果：
在这里插入图片描述

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

jsp 中的代码：

<a href="springmvc/useCookieValue">绑定 cookie 的值</a>

控制器中的代码：

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

运行结果：
在这里插入图片描述

ModelAttribute注解

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

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

基于 POJO 属性的基本使用：
jps 代码：

<!-- ModelAttribute 注解的基本使用 -->
<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"; 
}

运行结果：
在这里插入图片描述

基于 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 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 的应用场景示例 2：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注解

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

jsp 中的代码：

<!-- SessionAttribute 注解的使用 --> <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(value ={"username","password"},types={Integer.class}) 
public class SessionAttributeController {
	/**
	* 把数据存入 SessionAttribute
	* @param model
	* @return
	* Model 是 spring 提供的一个接口，该接口有一个实现类 ExtendedModelMap
	* 该类继承了 ModelMap，而 ModelMap 就是 LinkedHashMap 子类
	*/
	@RequestMapping("/testPut") 
	public String testPut(Model model){ 
		model.addAttribute("username", "泰斯特"); 
	 	model.addAttribute("password","123456"); 
	 	model.addAttribute("age", 31); 
	 	//跳转之前将数据保存到 username、password 和 age 中，因为注解@SessionAttribute 中有这几个参数 
	 	return "success"; 
	} 
 
	@RequestMapping("/testGet") 
	public String testGet(ModelMap model){ 
		System.out.println(model.get("username")+";"+model.get("password")+";"+model.get("age")); 
		return "success"; 
	} 
 
	@RequestMapping("/testClean") 
	public String complete(SessionStatus sessionStatus){ 
		sessionStatus.setComplete(); 
	 	return "success"; 
	} 
}

龙源lll

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
打赏
0
评论
SpringMVC--常用注解

RequestMapping：映射请求和处理方法，建立请求URL和处理方法之间的对应关系，可以使用@RequestMapping注解作用在方法或类上，RequestMapping的路径可以不编写 / 表示应用的根目录开始。 RequestMapping的属性：
复制链接

扫一扫