SpringMVC笔记一
SpringMVC-01
1.SpringMVC概述
Spring 为展现层提供的基于 MVC 设计理念的优秀的 Web 框架,是目前最主流的MVC 框架之一。
一种轻量级的、基于MVC的Web层应用框架。它能让我们对请求数据的出来,响应数据的处理,页面的跳转等等常见的web操作变得更加简单方便。
2.入门案例
①导入相关依赖
<dependencies> <!-- servlet依赖 --> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>3.1.0</version> <scope>provided</scope> </dependency> <!--jsp依赖 --> <dependency> <groupId>javax.servlet.jsp</groupId> <artifactId>jsp-api</artifactId> <version>2.1</version> <scope>provided</scope> </dependency> <!--springmvc的依赖--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>5.1.9.RELEASE</version> </dependency> <!-- jackson,帮助进行json转换--> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.0</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.apache.tomcat.maven</groupId> <artifactId>tomcat7-maven-plugin</artifactId> <version>2.2</version> <configuration> <!--端口--> <port>81</port> <!--项目路径--> <path>/</path> <!--解决get请求中文乱码--> <uriEncoding>utf-8</uriEncoding> </configuration> </plugin> </plugins> </build>
②配置web.xml
<servlet> <servlet-name>DispatcherServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <!-- 为DispatcherServlet提供初始化参数的 设置springmvc配置文件的路径 name是固定的,必须是contextConfigLocation value指的是SpringMVC配置文件的位置 --> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring-mvc.xml</param-value> </init-param> <!-- 指定项目启动就初始化DispatcherServlet --> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>DispatcherServlet</servlet-name> <!-- / 表示当前servlet映射除jsp之外的所有请求(包含静态资源) *.do 表示.do结尾的请求路径才能被SpringMVC处理(老项目会出现) /* 表示当前servlet映射所有请求(包含静态资源,jsp),不应该使用其配置DispatcherServlet --> <url-pattern>/</url-pattern> </servlet-mapping> <!--乱码处理过滤器,由SpringMVC提供--> <!-- 处理post请求乱码 --> <filter> <filter-name>CharacterEncodingFilter</filter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> <init-param> <!-- name固定不变,value值根据需要设置 --> <param-name>encoding</param-name> <param-value>UTF-8</param-value> </init-param> </filter> <filter-mapping> <filter-name>CharacterEncodingFilter</filter-name> <!-- 所有请求都设置utf-8的编码 --> <url-pattern>/*</url-pattern> </filter-mapping>
③配置SpringMVC
在resources目录下创建mvc的配置文件spring-mvc.xml
<!-- SpringMVC只扫描controller包即可 --> <context:component-scan base-package="com.sangeng.controller"/> <!-- 解决静态资源访问问题,如果不加mvc:annotation-driven会导致无法访问handler--> <mvc:default-servlet-handler/> <!--解决响应乱码--> <mvc:annotation-driven> <mvc:message-converters> <bean class="org.springframework.http.converter.StringHttpMessageConverter"> <constructor-arg value="utf-8"/> </bean> </mvc:message-converters> </mvc:annotation-driven>
④创建测试用的jsp页面
在webapp下创建success.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>Title</title> </head> <body> 成功 </body> </html>
⑤编写Controller
定义一个类,在类上加上@Controller注解,声明其是一个Controller。主要要创建在之前注解扫描所配置的包下。
然后定义一个方法,在方法上加上@RequestMapping来指定哪些请求会被该方法所处理。
@Controller public class TestController { @RequestMapping("/hello")//指定请求路径是/hello的才能被该方法处理 public String hello(){ System.out.println("hello"); return "/success.jsp";//跳转到success.jsp } }
3.设置请求映射规则@RequestMapping
该注解可以加到方法上或者是类上。(查看其源码可知)
我们可以用其来设定所能匹配请求的要求。只有符合了设置的要求,请求才能被加了该注解的方法或类处理。
3.1 指定请求路径
path或者value属性都可以用来指定请求路径。
例如:
我们期望让请求的资源路径为/test/testPath的请求能够被testPath方法处理则可以写如下代码
@Controller @RequestMapping("/test") public class TestController { @RequestMapping("/testPath") public String testPath(){ return "/success.jsp"; } }
3.2 指定请求方式
method属性可以用来指定可处理的请求方式。
例如:
我们期望让请求的资源路径为/test/testMethod的POST请求能够被testMethod方法处理。则可以写如下代码
@Controller @RequestMapping("/test") public class TestController { @RequestMapping(value = "/testMethod",method = RequestMethod.POST) public String testMethod(){ System.out.println("testMethod处理了请求"); return "/success.jsp"; } }
注意:我们可以也可以运用如下注解来进行替换
-
@PostMapping 等价于 @RequestMapping(method = RequestMethod.POST)
-
@GetMapping 等价于 @RequestMapping(method = RequestMethod.GET)
-
@PutMapping 等价于 @RequestMapping(method = RequestMethod.PUT)
-
@DeleteMapping 等价于 @RequestMapping(method = RequestMethod.DELETE)
例如:
上面的需求我们可以使用下面的写法实现
@Controller @RequestMapping("/test") public class TestController { @PostMapping(value = "/testMethod") public String testMethod(){ System.out.println("testMethod处理了请求"); return "/success.jsp"; } }
3.3 指定请求参数
我们可以使用params属性来对请求参数进行一些限制。可以要求必须具有某些参数,或者是某些参数必须是某个值,或者是某些参数必须不是某个值。
例如:
我们期望让请求的资源路径为/test/testParams的GET请求,并且请求参数中具有code参数的请求能够被testParams方法处理。则可以写如下代码
@Controller @RequestMapping("/test") public class TestController { @RequestMapping(value = "/testParams",method = RequestMethod.GET,params = "code") public String testParams(){ System.out.println("testParams处理了请求"); return "/success.jsp"; } }
如果是要求不能有code这个参数可以把改成如下形式
@Controller @RequestMapping("/test") public class TestController { @RequestMapping(value = "/testParams",method = RequestMethod.GET,params = "!code") public String testParams(){ System.out.println("testParams处理了请求"); return "/success.jsp"; } }
如果要求有code这参数,并且这参数值必须是某个值可以改成如下形式
@Controller @RequestMapping("/test") public class TestController { @RequestMapping(value = "/testParams",method = RequestMethod.GET,params = "code=sgct") public String testParams(){ System.out.println("testParams处理了请求"); return "/success.jsp"; } }
如果要求有code这参数,并且这参数值必须不是某个值可以改成如下形式
@Controller @RequestMapping("/test") public class TestController { @RequestMapping(value = "/testParams",method = RequestMethod.GET,params = "code!=sgct") public String testParams(){ System.out.println("testParams处理了请求"); return "/success.jsp"; } }
3.4 指定请求头
我们可以使用headers属性来对请求头进行一些限制。
例如:
我们期望让请求的资源路径为/test/testHeaders的GET请求,并且请求头中具有deviceType的请求能够被testHeaders方法处理。则可以写如下代码
@Controller @RequestMapping("/test") public class TestController { @RequestMapping(value = "/testHeaders",method = RequestMethod.GET,headers = "deviceType") public String testHeaders(){ System.out.println("testHeaders处理了请求"); return "/success.jsp"; } }
如果是要求不能有deviceType这个请求头可以把改成如下形式
@Controller @RequestMapping("/test") public class TestController { @RequestMapping(value = "/testHeaders",method = RequestMethod.GET,headers = "!deviceType") public String testHeaders(){ System.out.println("testHeaders处理了请求"); return "/success.jsp"; } }
如果要求有deviceType这个请求头,并且其值必须是某个值可以改成如下形式
@Controller @RequestMapping("/test") public class TestController { @RequestMapping(value = "/testHeaders",method = RequestMethod.GET,headers = "deviceType=ios") public String testHeaders(){ System.out.println("testHeaders处理了请求"); return "/success.jsp"; } }
如果要求有deviceType这个请求头,并且其值必须不是某个值可以改成如下形式
@Controller @RequestMapping("/test") public class TestController { @RequestMapping(value = "/testHeaders",method = RequestMethod.GET,headers = "deviceType!=ios") public String testHeaders(){ System.out.println("testHeaders处理了请求"); return "/success.jsp"; } }
3.5 指定请求头Content-Type
我们可以使用consumes属性来对Content-Type这个请求头进行一些限制。
范例一
我们期望让请求的资源路径为/test/testConsumes的POST请求,并且请求头中的Content-Type头必须为 multipart/from-data 的请求能够被testConsumes方法处理。则可以写如下代码
@RequestMapping(value = "/testConsumes",method = RequestMethod.POST,consumes = "multipart/from-data") public String testConsumes(){ System.out.println("testConsumes处理了请求"); return "/success.jsp"; }
范例二
如果我们要求请求头Content-Type的值必须不能为某个multipart/from-data则可以改成如下形式:
@RequestMapping(value = "/testConsumes",method = RequestMethod.POST,consumes = "!multipart/from-data") public String testConsumes(){ System.out.println("testConsumes处理了请求"); return "/success.jsp"; }
4.RestFul风格
RestFul是一种网络应用程序的设计风格和开发方式 。现在很多互联网企业的网络接口定义都会符合其风格。
主要规则如下:
-
每一个URI代表1种资源
-
客户端使用GET、POST、PUT、DELETE 4个表示操作方式的动词对服务端资源进行操作:GET用来获取资源,POST用来新建资源,PUT用来更新资源,DELETE用来删除资源;
-
简单参数例如id等写到url路径上 例如: /user/1 HTTP GET:获取id=1的user信息 /user/1 HTTP DELETE :删除id=1的user信息
-
复杂的参数转换成json或者xml(现在基本都是json)写到请求体中。
5.获取请求参数
5.1 获取路径参数
RestFul风格的接口一些参数是在请求路径上的。类似: /user/1 这里的1就是id。
如果我们想获取这种格式的数据可以使用@PathVariable来实现。
范例一
要求定义个RestFul风格的接口,该接口可以用来根据id查询用户。请求路径要求为 /user ,请求方式要求为GET。
而请求参数id要写在请求路径上,例如 /user/1 这里的1就是id。
我们可以定义如下方法,通过如下方式来获取路径参数:
@Controller public class UserController { @RequestMapping(value = "/user/{id}",method = RequestMethod.GET) public String findUserById( @PathVariable("id")Integer id){ System.out.println("findUserById"); System.out.println(id); return "/success.jsp"; } }
范例二
如果这个接口,想根据id和username查询用户。请求路径要求为 /user ,请求方式要求为GET。
而请求参数id和name要写在请求路径上,例如 /user/1/zs 这里的1就是id,zs是name
我们可以定义如下方法,通过如下方式来获取路径参数:
@Controller public class UserController { @RequestMapping(value = "/user/{id}/{name}",method = RequestMethod.GET) public String findUser(@PathVariable("id") Integer id,@PathVariable("name") String name){ System.out.println("findUser"); System.out.println(id); System.out.println(name); return "/success.jsp"; } }
5.2 获取请求体中的Json格式参数
RestFul风格的接口一些比较复杂的参数会转换成Json通过请求体传递过来。这种时候我们可以使用@RequestBody注解获取请求体中的数据。
5.2.1 配置
SpringMVC可以帮我们把json数据转换成我们需要的类型。但是需要进行一些基本配置。SpringMVC默认会使用jackson来进行json的解析。所以我们需要导入jackson的依赖(前面我们已经导入过)。
<!-- jackson,帮助进行json转换--> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.0</version> </dependency>
然后还要配置注解驱动(前面已经配置过)
<mvc:annotation-driven> </mvc:annotation-driven>
5.2.2 使用
范例一
要求定义个RestFul风格的接口,该接口可以用来新建用户。请求路径要求为 /user ,请求方式要求为POST。
用户数据会转换成json通过请求体传递。
请求体数据
{"name":"三更","age":15}
1.获取参数封装成实体对象
如果我们想把Json数据获取出来封装User对象,我们可以这样定义方法:
@Controller public class UserController { @RequestMapping(value = "/user",method = RequestMethod.POST) public String insertUser(@RequestBody User user){ System.out.println("insertUser"); System.out.println(user); return "/success.jsp"; } }
User实体类如下:
@Data @NoArgsConstructor @AllArgsConstructor public class User { private Integer id; private String name; private Integer age; }
2.获取参数封装成Map集合
也可以把该数据获取出来封装成Map集合:
@RequestMapping(value = "/user",method = RequestMethod.POST) public String insertUser(@RequestBody Map map){ System.out.println("insertUser"); System.out.println(map); return "/success.jsp"; }
范例二
如果请求体传递过来的数据是一个User集合转换成的json,Json数据可以这样定义:
[{"name":"三更1","age":14},{"name":"三更2","age":15},{"name":"三更3","age":16}]
方法定义:
@RequestMapping(value = "/users",method = RequestMethod.POST) public String insertUsers(@RequestBody List<User> users){ System.out.println("insertUsers"); System.out.println(users); return "/success.jsp"; }
5.2.3 注意事项
如果需要使用@RequestBody来获取请求体中Json并且进行转换,要求请求头 Content-Type 的值要为: application/json 。
5.3 获取QueryString格式参数
如果接口的参数是使用QueryString的格式的话,我们也可以使用SpringMVC快速获取参数。
我们可以使用@RequestParam来获取QueryString格式的参数。
5.3.1 使用
范例一
要求定义个接口,该接口请求路径要求为 /testRequestParam,请求方式无要求。参数为id和name和likes。使用QueryString的格式传递。
1.参数单独的获取
如果我们想把id,name,likes单独获取出来可以使用如下写法:
在方法中定义方法参数,方法参数名要和请求参数名一致,这种情况下我们可以省略@RequestParam注解。
@RequestMapping("/testRquestParam") public String testRquestParam(Integer id, String name, String[] likes){ System.out.println("testRquestParam"); System.out.println(id); System.out.println(name); System.out.println(Arrays.toString(likes)); return "/success.jsp"; }
如果方法参数名和请求参数名不一致,我们可以加上@RequestParam注解例如:
@RequestMapping("/testRquestParam") public String testRquestParam(@RequestParam("id") Integer uid,@RequestParam("name") String name, @RequestParam("likes")String[] likes){ System.out.println("testRquestParam"); System.out.println(uid); System.out.println(name); System.out.println(Arrays.toString(likes)); return "/success.jsp"; }
2.获取参数封装成实体对象
如果我们想把这些参数封装到一个User对象中可以使用如下写法:
@RequestMapping("/testRquestParam") public String testRquestParam(User user){ System.out.println("testRquestParam"); System.out.println(user); return "/success.jsp"; }
User类定义如下:
@Data @NoArgsConstructor @AllArgsConstructor public class User { private Integer id; private String name; private Integer age; private String[] likes; }
测试时请求url如下:
http://localhost:81/testRquestParam?id=1&name=三更草堂&likes=编程&likes=录课&likes=烫头
注意:实体类中的成员变量要和请求参数名对应上。并且要提供对应的set/get方法。
5.4 相关注解其他属性
5.4.1 required
代表是否必须,默认值为true也就是必须要有对应的参数。如果没有就会报错。
如果对应的参数可传可不传则可以把去设置为fasle
例如:
@RequestMapping("/testRquestParam") public String testRquestParam(@RequestParam(value = "id",required = false) Integer uid,@RequestParam("name") String name, @RequestParam("likes")String[] likes){ System.out.println("testRquestParam"); System.out.println(uid); System.out.println(name); System.out.println(Arrays.toString(likes)); return "/success.jsp"; }
5.4.2 defaultValue
如果对应的参数没有,我们可以用defaultValue属性设置默认值。
例如:
@RequestMapping("/testRquestParam") public String testRquestParam(@RequestParam(value = "id",required = false,defaultValue = "777") Integer uid,@RequestParam("name") String name, @RequestParam("likes")String[] likes){ System.out.println("testRquestParam"); System.out.println(uid); System.out.println(name); System.out.println(Arrays.toString(likes)); return "/success.jsp"; }
99. 常见问题
①定义了请求路径请求方式相同的方法
②json格式数据却无法用@RequestBody获取
③获取不到QueryString的参数
本文作者:Appletree24
本文链接:https://www.cnblogs.com/appletree24/p/16484026.html
版权声明:本作品采用知识共享署名-非商业性使用-禁止演绎 2.5 中国大陆许可协议进行许可。
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步