【玩转Spring】spring mvc
M:Model 模型
V:View 视图
C:Controller 控制器
Spring MVC是基于模型-视图-控制器模式实现的。不管你是struts,还是Spring MVC,只要是基于Java的WEB框架,都会通过一个前端控制器器。在Spring MVC中DispatcherServlet就是它的前端控制器,那么这个前端控制器做了什么呢?
DispatcherServlet
明白了DispatcherServlet是Spring MVC的前端控制器,那么我们又是怎么将请求全部先发给前端控制器,然后由前端控制器来控制跳转到相应的组件呢?
注意,如果要使用注解的方式启动MVC,你的项目必须部署在支持servlet3.0的容器当中,如tomcat7或者更好的版本;这是由于在Servlet 3.0环境中, 容器会在类路径中查找实现javax.servlet.ServletContainerInitializer接口的类, 如果能发现的话, 就会用它来配置Servlet容器。而Spring提供了这个接口的实现, 名为SpringServletContainerInitializer, 这个类反过来又会查找实现WebApplicationInitializer的类并将配置的任务交给它们来完成。
程序一:配置前端控制器
/***********************DispatcherServlet*******************/
public class ServletInit extends AbstractAnnotationConfigDispatcherServletInitializer{
public ServletInit() {
System.out.println("dispatcherservlet启动了");
}
//指定非WEB相关的配置类
@Override
protected Class<?>[] getRootConfigClasses() {
return new Class[] {RootConfig.class};
}
//指定WEB启动的配置类
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class[] {WebConfig.class};
}
//将DispatcherServlet映射到 "/"
@Override
protected String[] getServletMappings() {
return new String[] {"/"};
}
}
/*************************RooConfig**********************/
@Configuration
@ComponentScan(basePackages= {"mvc.logic"})
public class RootConfig {
public RootConfig() {
System.out.println("RootConfig启动");
}
}
/*************************WebConfig**********************/
@Configuration
@ComponentScan(basePackages= {"mvc.web"})
@EnableWebMvc
public class WebConfig {
public WebConfig() {
System.out.println("WebConfig启动");
}
}
上面的代码有两个问题
1、没有配置视图解析器
2、对静态资源也进行了拦截
视图解析器
视图解析器的作用是将逻辑视图转为物理视图,所有的视图解析器都必须实现ViewResolver接口。Spring MVC将按照你配置的不同的视图解析器来对模板进行渲染。Spring为提供了对多种视图的支持,常用的是以下三种:
-
InternalResourceViewResolver 将视图解析为JSP
-
FreeMarketViewResolver 将视图解析为FreeMarker模板
-
ThymeleafViewResolver 将视图解析为Thymeleaf模板
程序二:JSP视图解析器
@Configuration
@ComponentScan(basePackages= {"mvc.web"})
@EnableWebMvc
public class WebConfig extends WebMvcConfigurerAdapter{
public WebConfig() {
System.out.println("WebConfig启动");
}
//配置JSP视图解析器
@Bean
public ViewResolver viewResolver() {
InternalResourceViewResolver viewreResolver = new InternalResourceViewResolver("/WEB-INF/views/",".jsp");
return viewreResolver;
}
//配置静态资源过滤
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
}
控制器
控制器是真正对数据进行处理的地方,主要包括了参数的接收和view的返回。
程序三:简单的控制器
@Controller
public class UserController {
public UserController() {
System.out.println("UserController被启动了");
}
/*************表示接收处理路径为index的,GET方式的请求********/
@RequestMapping(value="/index",method=RequestMethod.GET)
public void index() {
System.out.println("调用了index");
}
}
控制器其实就是一个类,只不过使用@RequestMaaping将方法与路径进行了绑定。
参数的接收
@ReqeustParame == request.getParameter
@RequestMapping(value="/index/",method=RequestMethod.GET)
public void index(@RequestParam("userName") String userName ) {
System.out.println("调用了index");
}
@PathVariable
@RequestMapping(value="/index/{userName}",method=RequestMethod.GET)
public void index(@PathVariable("userName") String userName ) {
System.out.println("调用了index");
}
视图返回
返回一个视图名
@RequestMapping(value="/index/",method=RequestMethod.GET)
public String index(@RequestParam("userName") String userName ) {
return "index";
}
返回ModelAndView
@RequestMapping(value="/index/",method=RequestMethod.GET)
public ModelAndView index(@RequestParam("userName") String userName ) {
ModelAndView modelAndView = new ModelAndView();
modelAndView.addObject("", "");
modelAndView.setViewName("");
return modelAndView;
}
文件上传
首先我们想一想文件上传我们在服务端知道些什么?
-
文件名
-
文件类型
-
文件大小
-
文件
那么Spring MVC是怎么处理这些问题的呢?
上一节我们已经实现自定义DispatcherServlet,但是在DispatcherServlet中并未实现任何解析multipart请求数据的功能。它将该任务委托给了Spring中MultipartResolver策略接口的实现, 通过这个实现类来解析multipart请求中的内容。 从Spring 3.1开始, Spring内置了两个MultipartResolver的实现供我们选择:CommonsMultipartResolver( 使用Jakarta Commons FileUpload解析multipart请求);StandardServletMultipartResolver(依赖于Servlet 3.0对multipart请求的支持)。一般来讲, 在这两者之间, StandardServletMultipartResolver可能会是优选的方案(不依赖于外部组件)。
程序一:在WebConfig中配置MultipartResolver
@Bean
public MultipartResolver multipartResolver() {
return new StandardServletMultipartResolver();
}
同时在DispatcherServlet中,你还需要重写customizeRegistration函数。
程序二:配置文件上传的相关参数
@Override
protected void customizeRegistration(Dynamic registration) {
String location = "E:/spring-mvc/tmp/uploads";
File file = new File(location);
if(!file.exists()) {
file.mkdirs();
}
//每一个文件为3M
long maxFileSize = 1024 * 1024 * 3;
//一共上传15M的内容
long requestFileSzie = maxFileSize * 5;
//当缓存中有好大的时候,写入磁盘
int fileSizeThreshold = 0;
registration.setMultipartConfig(
new MultipartConfigElement(
location,
maxFileSize,
requestFileSzie ,
fileSizeThreshold));
}
程序三:在controller中获取MultipartFile数据
@RequestMapping(value="/upload")
public String upload(@RequestPart("myFile") MultipartFile myFile) {
System.out.println("文件名称:"+myFile.getOriginalFilename());
return "";
}
至此,Spring MVC文件上传就完了,是不是非常简单,非常感谢Spring为我们带来如此简便的文件上传方法。
异常处理
在Http中,大家经常会碰到404、500等常见异常错误码,但是我们不可以直接将错误码返回给用户,那么我们应该怎么做?在前面的Spring AOP中讲过,可以将所有的异常进行统一处理,但是又怎么返回到指定界面呢?
Spring提供了多种方式将异常转换为响应:
-
特定的Spring异常将会自动映射为指定的HTTP状态码;
-
异常上可以添加@ResponseStatus注解, 从而将其映射为某一个HTTP的状态码
-
在方法上可以添加@ExceptionHandler注解, 使其用来处理异常。
第一种和第二种方式是指将特定情况下的异常转换为HTTP状态码。第三种是对异常的处理。
程序四:@ResponseStatus
@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR)
public class MyExcetion extends RuntimeException{
}
需要注意的的是,@ResponseStatus是注解在异常类上的
当得到我们需要的异常之后,我们需要对异常进行处理,Spring MVC利用了AOP的原理,加入了@ControllerAdvice注解,此注解能够拦截所有我们定义的异常
程序五:@ControllerAdvice + @ExceptionHandler
@ControllerAdvice
public class ExceptionAdvice {
@ExceptionHandler(MyExcetion.class)
public String exception() {
return "error/500";
}
}
Spring中的过滤器
程序一:自定义Filter
/////实现Filter类,自定义Filter
public class SessionFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("过滤器启动");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
System.out.println("拦截到了访问请求 ");
}
@Override
public void destroy() {
System.out.println("过滤器销毁");
}
}
/////web.xml中定义Filter
<filter>
<filter-name>sessionFilter</filter-name>
<filter-class>myfilter.SessionFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>sessionFilter</filter-name>
<url-pattern>*</url-pattern>
</filter-mapping>
1、Filter在启动时会被初始化,调用一次init方法,且只会初始化一次
2、按照XML定义顺序进行拦截
Spring 拦截器
spring拦截器要实现的功能从名称就看出,那就是拦截用户的请求,功能相似于过滤器。那么它们有什么不同呢?
不管怎么说,把拦截器先运行起来。在Webconfig配置文件中提供了一个addInterceptors函数来完成注册自定义拦截器,就这么简单任性。
程序二:自定义拦截器
/////自定义Interceptor
@Component
public class SessionInterceptor implements HandlerInterceptor{
public SessionInterceptor() {
System.out.println("---SessionInterceptor---");
}
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler)
throws Exception {
System.out.println("---preHandle----");
return true;
}
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("---postHandle----");
}
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception ex)
throws Exception {
System.out.println("---afterCompletion----");
}
}
/////注册sessionInterceptor
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(sessionInterceptor).addPathPatterns("/user/*");
}
如果你以为Spring拦截器是仿照Filter来拦截URL那说明你太简单了。Spring拦截器其实是利用了Aop的原理。正是因为如此,我们才能看到上面的preHander、postHander、afterCompltion。
-
preHander:被@RequestMapping注解的方法执行前调用
-
postHander:被@RequestMapping注解的方法执行后未返回ModelView之前调用
-
afterCompltion:方法执行完成后调用
preHahder如果返回false,则postHander不执行。
多个拦截器的执行顺序与注册顺序相关
现在我们再来看Spring MVC的调用顺序,就一目了然了。先通过自定义DispatcherServlet注解启动配置类的方式启动Spring + MVC。实际真正起分发作用的还是org.springframework.web.servlet.DispatcherServlet.doServiet()方法。
知识星球