web编程(1) spring-webmvc 鸟瞰

sjzwangxufeng

已于 2023-11-15 11:16:45 修改

阅读量51

点赞数

分类专栏： web编程文章标签： spring java 后端

于 2023-10-25 16:03:13 首次发布

本文链接：https://blog.csdn.net/sjzwangxufeng/article/details/133994016

版权

web编程专栏收录该内容

7 篇文章 0 订阅

订阅专栏

1 概述

既然是鸟瞰，就先抛开具体的技术，从外部视角，最简单的流程开始。

1.1 简单流程

如果不依赖tomcat、spring webmvc 等成熟技术框架，只是通过JDK提供的TCP类库来处理，我想对于一个http请求，最简单的处理流程，应该需要包含以下步骤:

步骤1：解析http协议数据包，封装为Request类对象，通过它可以获取请求相关所有数据。

步骤2：通过url匹配、映射到一个具体的Controller类method。

步骤3：解析Request对象数据，转换为控制类method的参数数据。

步骤4：校验method的参数数据。

步骤5：invoke控制类method方法。

步骤6：按视图格式(json，xml，html等)，序列化返回值。

步骤7：将视图数据，按http协议格式刷入TCP响应流。

1.2 spring-mvc流程

2 核心类

以下是spring-mvc处理过程中，最常见的几个类。

(1) DispatcherServlet类

所有spring-mvc处理请求，都由该类的doDispatch方法统一处理，从匹配handler，到invoke该handler, 以及最后view的处理，贯穿整个过程。

(2) RequestMappingHandlerMapping类

该类负责匹配handler，通过url查找到唯一的controller.method，并匹配相关的spring拦截器，然后封装为HandlerExecutionChain实例，该实例习惯称handler。

为了提高匹配效率，在web项目启动时，它的内部类MappingRegistry，会扫描、加载所有RequestMapping方法，预先构建url查找字典。

(3) RequestMappingHandlerAdapter类

该类负责handler的真实invoke处理，以及调用前的参数解析、校验等准备逻辑。

(4) HandlerExecutionChain类

包含HandlerMethod实例，以及HandlerInterceptor列表。

3 核心环节

3.1 解析http请求包

这部分由servlet容器(tomcat)处理，将请求数据包解析、封装到HttpServletRequest对象。

该过程会涉及到url、请求body解码问题，其中url路径部分由servlet容器解码。

而请求body部分由匹配的Servlet解析处理。

提示: tomcat的url编码配置: server.tomcat.uri-encoding=utf-8

3.2 web过滤器

过滤器 Filter 属于servlet 规范概念，可对http请求进行统一拦截、重定向、修改等处理，样例如下:

@Order(1)
@WebFilter(filterName = "MyFilter", urlPatterns = {"/*"})
public class MyFilter implements Filter {	

	private static final String FORWARD_TO_URL = "/xxx/xxx";
	private static final String REDIRECT_TO_URL = "https://www.baidu.com";	

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 
			throws IOException, ServletException {

		HttpServletRequest httpRequest = (HttpServletRequest)request;
		HttpServletResponse httpResponse = (HttpServletResponse)response;	
		
		// 内部forward
		if (匹配条件) {
			request.getRequestDispatcher(FORWARD_TO_URL).forward(request, response);
			return;
		}
		
		// 外部redirect
		if (匹配条件) {
			httpResponse.sendRedirect(REDIRECT_TO_URL);
			return;
		}

        // 日志
        // 其他等等
			
		chain.doFilter(request, response);
	}
}

细节可以参考，以前整理的文章：切面编程(2): web过滤器

3.3 spring拦截器

spring拦截器HandlerInterceptor，同样可对http请求进行统一拦截处理，跟web过滤器不同的是，除request，response两个参数外，还包含handler参数，通过该参数，可以获取到匹配本次请求controller类的method相关信息，依据该部分信息，可以实施一些前置业务处理逻辑。

下面是拦截器样例:

@Component
public class DemoInterceptor1 implements HandlerInterceptor {
	
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {		
		System.out.println(String.format("DemoInterceptor1.preHandle, url:%s", request.getRequestURL()));				
		return true;
	}

	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
		System.out.println(String.format("DemoInterceptor1.postHandle, url:%s", request.getRequestURL()));		
	}

	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
		System.out.println(String.format("DemoInterceptor1.afterCompletion, url:%s, ex:%s", request.getRequestURL(), ex));
	}
}

细节可以参考，以前整理的文章：切面编程(3)：spring拦截器

3.4 请求参数转换、解析

spring提供了多种处理方式，主要有Converter、HttpMessageConverter，以及注解等。

(1) Converter 主要解析Url查询参数、请求体body为表单格式参数解析，样例如下:

public class StringToDateConverter implements Converter<String, Date> {

	@Override
	public Date convert(String source) {
		SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
		dateFormat.setLenient(false);
		try {
			return dateFormat.parse(source);
		} catch (Throwable t) {
			throw new RuntimeException("日期类型转换错误", t);			
		}
	}
}

(2) HttpMessageConverter 则主要依据Content-Type，对请求body解析，例如: json，xml等。

public interface HttpMessageConverter<T> {

	boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
	boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);

	List<MediaType> getSupportedMediaTypes();

	T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;
	void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;
}

该部分就不展示样例，系统已内置了丰富的实现类，可以参考，如下:

org.springframework.http.converter.ByteArrayHttpMessageConverter
org.springframework.http.converter.StringHttpMessageConverter
org.springframework.http.converter.ResourceHttpMessageConverter
org.springframework.http.converter.xml.SourceHttpMessageConverter
org.springframework.http.converter.json.MappingJackson2HttpMessageConverter

以上类，有些还需要第三方类库支持，如MappingJackson2HttpMessageConverter，需要增加 jackson-databind 类库依赖。

(3) 注解

例如：@DateTimeFormat等

	@RequestMapping(value="/test1")
	@ResponseBody
	public String test1(
			Integer id,
			@DateTimeFormat(pattern = "yyyy-MM-dd")
			Date birthday) {
		
		return "hello";
	}

例如: @InitBinder

public abstract class BaseController {
	
	protected final Logger logger = LoggerFactory.getLogger(this.getClass()); 
	
    @InitBinder
    public void initBinder(WebDataBinder webDataBinder){
    	webDataBinder.registerCustomEditor(Date.class,new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"),true));
    }	
	
}

3.5 参数校验

通过@Validated注解对参数校验，并且支持通过分组方式，进行分场景校验，这部分大家常常忽视一个默认分组 Default.class，它可以跟其他分组class组合使用，例如:@Validated({Update.class, Default.class}，校验分组样例如下:

分组类:

public interface Update { }

控制类:

@RestController
@RequestMapping(value="/apple")
public class AppleController {
	
	@RequestMapping(value = "/insert", produces="application/json;charset=utf-8")
	public String insert(
			@Validated 
			@RequestBody Apple apple) {

		return "xx";
	}	
	
	@RequestMapping(value = "/update", produces="application/json;charset=utf-8")
	public String update(
			@Validated({Update.class, Default.class})
			@RequestBody Apple apple) {

		return "xx";
	}
}

参数类:

public class Apple implements Serializable {
	private static final long serialVersionUID = 1L;

	@NotNull(groups={Update.class}, message="id不能为空")
	@Range(min=0, max=10, message="取值范围0~10之间")
	private Integer id;
	
	@NotNull(message="name不能为空")
	private String name;
	
	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")
	private Date birthday;
	
	public Integer getId() {
		return id;
	}
	public void setId(Integer id) {
		this.id = id;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public Date getBirthday() {
		return birthday;
	}
	public void setBirthday(Date birthday) {
		this.birthday = birthday;
	}
}

以下是常见的部分注解:

@NotNull: 必须不为null
@NotEmpty: 值不为null且不为空，且类型为String。
@Min：值必须大于等于最小值，且类型为int，long，float，double。
@Max：值必须小于等于最小值，且类型为int，long，float，double。
@Range：值在最小值和最大值之间，且类型为BigDecimal，BigInteger，CharSequence，byte，short，int，long。
@Pattern: 必须符合指定的正则表达式，且类型为String。

提示：该部分依赖hibernate-validator类库，spring-boot 2.x低版本会默认绑定，高版本已剔除该依赖，需要手动添加依赖: spring-boot-starter-validation

4 配置

一般通过实例化spring提供的WebMvcConfigurer接口，进行统一配置，样例如下:

@Configuration
public class WebConfig implements WebMvcConfigurer {
	
	/*
	 * 静态资源 (通常动静分离后，已)
	 */	
	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
	}	
	
	/*
	 * 跨域资源共享 (通常在网络接入层进行统一配置)
	 */		
	@Override
    public void addCorsMappings(CorsRegistry registry) {
		registry.addMapping("/**")
        .allowedOrigins("http://localhost:8080", "https://www.example.com")
        .allowedMethods("GET", "POST")
        .allowCredentials(true);
    }	

	/*
	 * spring拦截器
	 */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**");
    }
    
	/*
	 * Converter转换类
	 */
	@Override
	public void addFormatters(FormatterRegistry registry) {		
		registry.addConverter(new StringToDateConverter());
	}
	
	/*
	 * HttpMessageConverter转换类
	 */	
	@Override
	public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
		
	}
		
	// 等等, 可参考WebMvcConfigurer了解，更多细节
}

5 异常

(1) 通过@ControllerAdvice注解，统一处理异常

@ControllerAdvice
public class GlobalExceptionHandler {
	
	private final Logger logger = LoggerFactory.getLogger(this.getClass());
	
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public String methodArgumentNotValidException(MethodArgumentNotValidException e){
    	logger.error("GlobalExceptionHandler error", e);
    	
    	FieldError f = e.getBindingResult().getFieldError();    	
    	logger.info("methodArgumentNotValidException: {}, {}, {}", f.getField(), f.getDefaultMessage(), f.getObjectName());
    	
    	return "GlobalExceptionHandler: " + e.getMessage();
    }	

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public String handleException(Exception e){
    	logger.error("GlobalExceptionHandler error", e);
        return "GlobalExceptionHandler: " + e.getMessage();
    }
}

(2) Controller类异常，单独进行处理

public abstract class BaseController {
	
	protected final Logger logger = LoggerFactory.getLogger(this.getClass());	
	
	@ExceptionHandler(Throwable.class)
	public void doThrowable(Throwable t, HttpServletRequest request, HttpServletResponse response) {
		logger.error("BaseController.doThrowable", t);
		
		try {
			response.setContentType("text/plain;charset=utf-8");
			response.getWriter().write(t.getMessage());
		} catch (Throwable tt) {
			logger.error("doThrowable异常", t);
		}
	}
}