SpringMVC介绍
SpringMVC是实现了Servlet的Web框架,在Servlet和业务功能之间,充当高级中介的角色,提高了开发效率。
环境搭建 & Hello MVC
目前SpringBoot大行其道,老式的SpringMVC应用,早已销声匿迹。所以,本文的SpringMVC案例,均使用SpringBoot完成。
链接:君子陶陶/learn-spring - Gitee.com
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.7</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
@RestController
public class HelloController {
/**
* 测试:在浏览器地址栏输入:http://127.0.0.1:8000/hello
*/
@RequestMapping("/hello")
public String helloWorld() {
return "hello world !";
}
}
绑定请求参数
SpringMVC绑定参数的来源,就是HTTP请求报文。支持多种方式,提取报文里的数据,绑定到方法的参数中。
老式参数绑定
@Controller
@RequestMapping("/jztt/user")
public class BaseUserController {
/**
* 测试URL:http://127.0.0.1:8000/jztt/user/query/name?name=jack&id=1
*/
@RequestMapping(value = "/query/name", method = {RequestMethod.GET})
public String queryByName(String name, Long id) {
System.out.println(name);
System.out.println(id);
return name;
}
@RequestMapping(value = "/create", method = {RequestMethod.POST})
public String create(UserDTO user) {
System.out.println(user.toString());
return user.toString();
}
/**
* 从原始的request对象,开发者手动解析参数
* <p>
* 这种方式比较低效,一般不推荐。作为一种兜底方案吧,在高级绑定方式不奏效时,可以使用。
*/
@RequestMapping("/query/origin")
public String queryFromRequest(HttpServletRequest request) {
System.out.println(request.getParameter("name"));
return request.getParameter("name");
}
}
注解式参数绑定【推荐】
@Controller
@RequestMapping("/jztt/user")
public class PopularUserController {
/**
* 使用@RequestParam注解
* <p>
* value表示指定接收的参数名称;
* required表示是否可以为空,默认true;
* defaultValue表示为空时的默认值
*/
@RequestMapping(value = "/query/name/v2", method = {RequestMethod.GET})
public String queryByNameV2(@RequestParam(value = "name", required = false, defaultValue = "Tom") String name) {
System.out.println(name);
return name;
}
/**
* 使用@PathVariable注解
* <p>
* 传输参数时可以不通过url?aa=bb&cc=dd的形式,通过url/aa/bb的方式进行参数传输
* <p>
* PathVariable是一种REST的API设计风格,设计得好,显得比较优雅。设计功力不够,就有点尴尬了。
* 另外,解析PathVariable的参数,比较耗性能,高并发场景不推荐。
*/
@RequestMapping(value = "/query/{name}/v3", method = {RequestMethod.GET})
public String queryByNameV3(@PathVariable String name) {
System.out.println(name);
return name;
}
/**
* 使用@RequestBody注解
* <p>
* 将请求体中的数据,反序列化成指定的对象类型,适用于传输数据为一个自定义的对象
*/
@RequestMapping(value = "/create/v2", method = {RequestMethod.POST})
public String createV2(@RequestBody UserDTO user) {
System.out.println(user.toString());
return user.toString();
}
/**
* 使用@RequestHeader,解析绑定请求头的参数
*/
@RequestMapping("/query/userAgent")
public String queryByUserAgent(@RequestHeader("User-Agent") String userAgent) {
System.out.println(userAgent);
return userAgent;
}
/**
* 使用@CookieValue获取cookie中的值
*/
@RequestMapping("/query/cookie")
public String queryFromCookie(@CookieValue("name") String name) {
System.out.println(name);
return name;
}
}
响应
响应数据【推荐】
前后端分离越来越流行,前端仅依赖后端提供数据,而页面跳转、参数传递等,不再需要SpringMVC做为媒介。所以,后端返回JSON类数据,成为了更流行的开发风格。
链接:君子陶陶/learn-spring - Gitee.com
@Controller
@RequestMapping("/jztt/user")
public class UserController {
/**
* 返回普通字符串
* <p>
* 测试URL:http://127.0.0.1:8000/jztt/user/query/name?name=jack
*/
@ResponseBody
@RequestMapping(value = "/query/name", method = {RequestMethod.GET})
public String queryByName(String name) {
System.out.println(name);
return name;
}
/**
* 返回对象
* <p>
* 返回格式:JSON
*/
@ResponseBody
@RequestMapping(value = "/query/any", method = {RequestMethod.GET})
public UserDTO queryAny() {
UserDTO user = UserDTO.of().setId(123L).setName("Tom").setAge(22);
System.out.println(user.toString());
return user;
}
}
响应页面
略
跳转页面
略
异常处理
异常处理,有多种方案。目前最推荐的方式是【@RestControllerAdvice + @ExceptionHandler】的组合模式。
链接:君子陶陶/learn-spring - Gitee.com
/**
* RestControllerAdvice:对Controller进行增强,返回值为JSON格式
*/
@Slf4j
@RestControllerAdvice
public class ControllerExceptionHandler {
/**
* 捕捉所有异常
*/
@ExceptionHandler(Throwable.class)
@ResponseStatus(HttpStatus.OK)
public CommonResult<?> exception(HttpServletRequest request,
HttpServletResponse response,
Exception exception) {
// 记录异常
log.warn(exception.getMessage());
// 返回标准模型
return CommonResult.ofFail("请求服务异常,请稍后重试");
}
}
/**
* 定义通用的返回模型
*/
@Data(staticConstructor = "of")
@Accessors(chain = true)
public class CommonResult<T> implements Serializable {
private String code;
private String message;
private T data;
public static CommonResult<?> ofFail(String message) {
return CommonResult.of().setMessage(message);
}
}
@Controller
@RequestMapping("/jztt/user")
public class UserController {
/**
* 返回对象
* <p>
* 返回格式:JSON
*/
@ResponseBody
@RequestMapping(value = "/query/any", method = {RequestMethod.GET})
public UserDTO queryAny() {
// 模拟异常
int result = 1 / 0;
UserDTO user = UserDTO.of().setId(123L).setName("Tom").setAge(22);
System.out.println(user.toString());
return user;
}
}
拦截器
链接:君子陶陶/learn-spring - Gitee.com
public class LogInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("============================ preHandle ================================");
// 返回true,表示不拦截
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("============================ postHandle ================================");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("============================ afterCompletion ================================");
}
}
@Configuration
public class UserConfiguration implements WebMvcConfigurer {
/**
* 注册拦截器
* <p>
* 实现接口WebMvcConfigurer,框架会回调addInterceptors()方法,完成拦截器的注册
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogInterceptor())
// 拦截所有请求
.addPathPatterns("/**");
}
}
@Controller
@RequestMapping("/jztt/user")
public class UserController {
/**
* 返回对象
* <p>
* 返回格式:JSON
*/
@ResponseBody
@RequestMapping(value = "/query/any", method = {RequestMethod.GET})
public UserDTO queryAny() {
UserDTO user = UserDTO.of().setId(123L).setName("Tom").setAge(22);
System.out.println(user.toString());
return user;
}
}