SpringMVC常用注解
项目结构

配置文件
-
pom.xml
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.xiaoge</groupId> <artifactId>commonly_annotation2</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <name>commonly_annotation2 Maven Webapp</name> <!-- FIXME change it to the project's website --> <url>http://www.example.com</url> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.7</maven.compiler.source> <maven.compiler.target>1.7</maven.compiler.target> <spring.version>5.0.2.RELEASE</spring.version> </properties> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>servlet-api</artifactId> <version>2.5</version> <scope>provided</scope> </dependency> <dependency> <groupId>javax.servlet.jsp</groupId> <artifactId>jsp-api</artifactId> <version>2.0</version> <scope>provided</scope> </dependency> </dependencies> <build> <finalName>commonly_annotation2</finalName> <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) --> <plugins> <plugin> <artifactId>maven-clean-plugin</artifactId> <version>3.1.0</version> </plugin> <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging --> <plugin> <artifactId>maven-resources-plugin</artifactId> <version>3.0.2</version> </plugin> <plugin> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.0</version> </plugin> <plugin> <artifactId>maven-surefire-plugin</artifactId> <version>2.22.1</version> </plugin> <plugin> <artifactId>maven-war-plugin</artifactId> <version>3.2.2</version> </plugin> <plugin> <artifactId>maven-install-plugin</artifactId> <version>2.5.2</version> </plugin> <plugin> <artifactId>maven-deploy-plugin</artifactId> <version>2.8.2</version> </plugin> </plugins> </pluginManagement> </build> </project> -
web.xml**(重点:中文乱码的配置)**
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd" > <web-app> <display-name>Archetype Created Web Application</display-name> <!-- 前端控制器 --> <servlet> <servlet-name>dispatcherServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring.xml</param-value> </init-param> <!-- 当启动服务器的时候创建servlet对象 --> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>dispatcherServlet</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> <!-- 配置解决中文乱码的过滤器 --> <filter> <filter-name>characterEncodingFilter</filter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> <init-param> <param-name>encoding</param-name> <param-value>UTF-8</param-value> </init-param> </filter> <filter-mapping> <filter-name>characterEncodingFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> </web-app> -
spring.xml**(重点:自定义类型转换的配置)**
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> <!-- 开启扫描注解 --> <context:component-scan base-package="com.xiaoge"></context:component-scan> <!-- 视图解析器 --> <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/pages/"></property> <property name="suffix" value=".jsp"></property> </bean> <!-- 配置自定义转换器 --> <bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean"> <property name="converters"> <set> <bean class="com.xiaoge.utils.StringToDateConverter"></bean> </set> </property> </bean> <!-- 开启SpringMVC注解 --> <mvc:annotation-driven conversion-service="conversionService"></mvc:annotation-driven> </beans>
实体类
-
Account
package com.xiaoge.domain; import java.util.Date; /** * @author xiaoge * @version 1.0 * @date 2020/4/16 18:03 * @detail */ public class Account { private String username; private String password; private Double Money; private Date date; public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public Double getMoney() { return Money; } public void setMoney(Double money) { Money = money; } public Date getDate() { return date; } public void setDate(Date date) { this.date = date; } @Override public String toString() { return "Account{" + "username='" + username + '\'' + ", password='" + password + '\'' + ", Money=" + Money + ", date=" + date + '}'; } } -
User
package com.xiaoge.domain; import java.util.Date; /** * @author xiaoge * @version 1.0 * @date 2020/4/16 18:03 * @detail */ public class User { private String uname; private Integer age; private Date date; public String getUname() { return uname; } public void setUname(String uname) { this.uname = uname; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } public Date getDate() { return date; } public void setDate(Date date) { this.date = date; } @Override public String toString() { return "User{" + "uname='" + uname + '\'' + ", age=" + age + ", date=" + date + '}'; } }
工具类
-
StringToDateConverter**(重点: 要实现类型转换必须实现Converte接口中的转换方法)**
package com.xiaoge.utils; import org.springframework.core.convert.converter.Converter; import java.text.DateFormat; import java.text.SimpleDateFormat; import java.util.Date; /** * @author xiaoge * @version 1.0 * @date 2020/4/15 20:02 * @detail 把字符串转换成日期 * * Converter<String, Date> String类型转换成Date类型 * 注意: 这里的泛型, 是你来设置的, 你想什么类型转换成什么类型, 泛型就怎么写 * */ public class StringToDateConverter implements Converter<String, Date> { /** * String source 传入进来字符串 * @param source * @return */ @Override public Date convert(String source) { // 判断 if (source == null || "".equals(source)) { throw new RuntimeException("date is null"); } else { // 设置字符串格式 DateFormat df = new SimpleDateFormat("yyyy-MM-dd"); try { // 将字符串转换成日期 return df.parse(source); } catch (Exception e) { throw new RuntimeException("data type converter error"); } } } }
控制器
-
AnnotationController**(重点: 注释, 每个注解的解释. 重点: ModelAttribute它会在控制器方法执行之前先执行)**
package com.xiaoge.controller; import com.xiaoge.domain.User; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.support.SessionStatus; import java.util.Date; import java.util.Map; /** * @author xiaoge * @version 1.0 * @date 2020/4/16 19:28 * @detail 常用注解 * * @RequestParam * 作用: 把请求中指定名称的参数给控制器中的形参赋值. * 属性: * value: 请求参数中的名称 * required: 请求参数中是否必须提供参数, 默认值是: true. * 表示必须提供, 如果不提供报错. * * @RequestBody * 作用: 用于获取请求体内容, 直接使用得到的是 key=value&key=value...结构的数据. * get请求方式不适用. * 属性: * required: 是否默认必须有请求体: * 默认值是: true. 当取值为true时, get请求方式会报错. * 如果取值为false, get请求得到是null. * * * @PathVaribale * 作用: * 用于绑定url中的占位符. 列如: 请求url中/delete/{id}, 这个{id}就是url占位符, * url支持占位符是spring3.0之后加入的. 是springmvc支持rest风格URL的一个重要标志. * 属性: * value: 用于指定url中占位符名称. * required: 是否必须提供占位符. * * * @RequestHeader * 作用: * 用于获取请求消息头 * 属性: * value: 提供消息头名称 * required: 是否必须有此消息头 * * * @CookieValue * 作用: * 用于把指定 cookie 名称的值传入控制器方法参数。 * 属性: * value:指定 cookie 的名称。 * required:是否必须有此 cookie。 * * * @ModelAttribute * 作用: * 该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。 * 出现在方法上,表示当前方法会在控制器的方法执行之前,先执行。它可以修饰没有返回值的方法,也可 * 以修饰有具体返回值的方法。 * 出现在参数上,获取指定的数据给参数赋值。 * 属性: * value:用于获取数据的 key。key 可以是 POJO 的属性名称,也可以是 map 结构的 key。 * 应用场景: * 当表单提交数据不是完整的实体类数据时,保证没有提交数据的字段使用数据库对象原来的数据。 * 例如: * 我们在编辑一个用户时,用户有一个创建信息字段,该字段的值是不允许被修改的。在提交表单数 * 据是肯定没有此字段的内容,一旦更新会把该字段内容置为 null,此时就可以使用此注解解决问题 * * * @SessionAttributes: 只能作用在类上 * 作用: * 用于多次执行控制器方法间的参数共享。 * 属性: * value:用于指定存入的属性名称. * type:用于指定存入的数据类型. * * */ @Controller @RequestMapping("/anno") @SessionAttributes("msg") // 把request域中的msg存入一份到session域中 public class AnnotationController { /** * 给参数赋值 * @param username * @return */ @RequestMapping("requestParam") public String requestParamAnnotation(@RequestParam("name") String username) { System.out.println(username); return "success"; } /** * 获取到请求体内容 * @param body * @return */ @RequestMapping(value = "requestBody", method = {RequestMethod.POST}) public String requestBodyAnnotation(@RequestBody String body) { System.out.println(body); return "success"; } /** * PathVariable注解 * @param id * @return */ @RequestMapping(value = "pathVariable/{sid}") public String pathVariableAnnotation(@PathVariable(name="sid") String id) { System.out.println(id); return "success"; } /** * RequestHeader注解 * @param header * @return */ @RequestMapping(value = "requestHeader") public String requestHeaderAnnotation(@RequestHeader(value="accept") String header) { System.out.println(header); return "success"; } /** * CookieValue注解 * @param cookie * @return */ @RequestMapping(value = "cookieValue") public String cookieValueAnnotation(@CookieValue(value="JSESSIONID", required = false) String cookie) { System.out.println(cookie); return "success"; } /** * ModelAttribute注解 在方法上 它会在控制器方法执行之前, 先执行. * @param uname * @return user */ /* @ModelAttribute public User showModel(String uname) { // System.out.println("执行了 showModel 方法: " + user.getUname()); User user = findUserName(uname); System.out.println("执行了 showModel 方法: " + user); return user; } */ /** * ModelAttribute注解 在方法上 它会在控制器方法执行之前, 先执行. * @param uname * @return */ @ModelAttribute public void showModel(String uname, Map<String, User> map) { User user = findUserName(uname); System.out.println("执行了 showModel 方法: " + user); map.put("abc", user); } /** * ModelAttribute注解 : * 如果ModelAttribute 修饰的方法有返回值, * 前端提交过来的参数封装在user里, 没有提交的参数, * 我们就用ModelAttribute修饰方法的返回值里的改参数, * 来封装到user里 * 列: * ModelAttribute修饰的方法: user: {uname = "张三", age = 12, date=Fri Apr 17 10:33:27 CST 2020} * 前端只传递了uname=张三&age = 12 * 这时modelAttributeAnnotation方法里的user里的date成员是null * 但是ModelAttribute修饰的方法有返回该对象user * 这时modelAttributeAnnotation方法里的user里的date成员就不是null, * 而是date=Fri Apr 17 10:33:27 CST 2020 * 注意: ModelAttribute修饰的方法没有有返回值时 * * @param user * @return */ /*@RequestMapping("modelAttribute") public String modelAttributeAnnotation(User user) { System.out.println("执行了 modelAttributeAnnotation 方法: " + user); return "success"; }*/ /** * ModelAttribute注解 : ModelAttribute修饰参数, 给参数赋值 * 注意: 传递给ModelAttribute注解的值是 map里面的key * @param user * @return */ @RequestMapping("modelAttribute") public String modelAttributeAnnotation(@ModelAttribute("abc") User user) { System.out.println("执行了 modelAttributeAnnotation 方法: " + user); return "success"; } /** * 模拟去数据库查询数据 * @param uname * @return */ public User findUserName(String uname) { User user = new User(); user.setUname(uname); user.setAge(12); user.setDate(new Date()); return user; } /** * SessionAttribute注解 * @param model * @return */ @RequestMapping("setSessionAttributes") public String setSessionAttribute(Model model) { // 把msg设置到request域中 model.addAttribute("msg", "小美"); return "success"; } /** * 获取值 * @param map * @return */ @RequestMapping("getSessionAttributes") public String getSessionAttribute(ModelMap map) { // 获取值 String msg = (String)map.get("msg"); System.out.println(msg); return "success"; } @RequestMapping("delSessionAttributes") public String delSessionAttribute(SessionStatus status) { // 删除session域中的数据 status.setComplete(); return "success"; } }
前台页面
-
index.jsp
<%-- Created by IntelliJ IDEA. User: xiaoge Date: 2020/4/19 Time: 下午2:32 To change this template use File | Settings | File Templates. --%> <%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>常用注解</title> </head> <body> <%-- RequestParam注解 --%> <a href="anno/requestParam?name=哈哈">RequestParam注解</a> <%-- RequestBody注解 --%> <form action="anno/requestBody" method="post"> 用户姓名: <input type="text" name="username"> <br /> 用户年龄: <input type="text" name="age"> <br /> <input type="submit" value="提交"> </form> <br /> <%-- PathVariable注解 --%> <a href="anno/pathVariable/3">PathVariable注解</a> <br /> <%-- RequestHeader注解 --%> <a href="anno/requestHeader">RequestHeader注解</a> <br /> <%-- CookieValue注解 --%> <a href="anno/cookieValue">CookieValue注解</a> <br /> <%-- ModelAttribute注解 --%> <a href="anno/modelAttribute?uname=张三">ModelAttribute注解</a> <br /> <%-- ModelAttribute注解 --%> <form action="anno/modelAttribute"> 用户姓名: <input type="text" name="uname"> <br /> 用户年龄: <input type="text" name="age"> <br /> <input type="submit" value="提交"> </form> <br /> <%-- ModelAttribute注解 --%> <a href="anno/setSessionAttributes">SessionAttributes注解设置值到域中</a> <br /> <%-- ModelAttribute注解 --%> <a href="anno/getSessionAttributes">SessionAttributes注解获取域中值</a> <br /> <%-- ModelAttribute注解 --%> <a href="anno/delSessionAttributes">SessionAttributes注解删除域中值</a> <br /> </body> </html> -
success.jsp
<%-- Created by IntelliJ IDEA. User: xiaoge Date: 2020/4/19 Time: 下午2:32 To change this template use File | Settings | File Templates. --%> <%@ page contentType="text/html;charset=UTF-8" language="java" isELIgnored="false" %> <html> <head> <title>成功</title> </head> <body> <h3>成功</h3> ${ msg } ${sessionScope} </body> </html>
浙公网安备 33010602011771号