使用配置类和注解代替 web.xml 和 SpringMVC 配置文件的功能
1 创建初始化类，代替 web.xml
在 Servlet3.0 环境中，容器会在类路径中查找实现 javax.servlet.ServletContainerInitializer 接口的类，如果找到的话就用它来配置 Servlet 容器。
Spring 提供了这个接口的实现，名为 SpringServletContainerInitializer，这个类反过来又会查找实现 WebApplicationInitializer 的类并将配置的任务交给它们来完成。Spring3.2 引入了一个便利的 WebApplicationInitializer 基础实现，名为 AbstractAnnotationConfigDispatcherServletInitializer，当我们的类扩展了 AbstractAnnotationConfigDispatcherServletInitializer 并将其部署到 Servlet3.0 容器的时候，容器会自动发现它，并用它来配置 Servlet 上下文。
public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {
// 指定 Spring 的配置类
@Override
protected Class<?>[] getRootConfigClasses() { return new Class[]{SpringConfig.class}; }
// 指定 SpringMVC 的配置类
@Override
protected Class<?>[] getServletConfigClasses() { return new Class[]{WebConfig.class}; }
// 指定 DispatcherServlet 的映射规则，即 url-pattern
@Override
protected String[] getServletMappings() { return new String[]{"/"}; }
// 添加过滤器
@Override
protected Filter[] getServletFilters() {
CharacterEncodingFilter encodingFilter = new CharacterEncodingFilter();
encodingFilter.setEncoding("UTF-8");
encodingFilter.setForceRequestEncoding(true);
HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
return new Filter[]{encodingFilter, hiddenHttpMethodFilter};
}
}2 创建 SpringConfig 配置类，代替 Spring 的配置文件
@Configuration
public class SpringConfig {
//ssm 整合之后，Spring 的配置信息写在此类中
}3 创建 WebConfig 配置类，代替 SpringMVC 的配置文件
- 扫描组件
- 视图解释器
- view-controller
- default-servlet-handler
- mvc 注解驱动
- 文件上传解析器
- 异常处理
- 拦截器
//配置类
@Configuration
//扫描组件
@ComponentScan("com.atguigu.mvc.controller")
//开启 MVC 注解驱动
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
//使用默认的 servlet 处理静态资源
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
//配置文件上传解析器
@Bean
public CommonsMultipartResolver multipartResolver(){
return new CommonsMultipartResolver();
}
//配置视图控制：页面跳转控制器，访问 /welcome 时，自动跳转到 /index
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/welcome").setViewName("index");
}
//配置拦截器
@Override
public void addInterceptors(InterceptorRegistry registry) {
AuthInterceptor authInterceptor= new AuthInterceptor();
registry.addInterceptor(authInterceptor)
.order(2) // 设置拦截器顺序
.addPathPatterns("/article/**") //拦截 article 开始的所有请求
.excludePathPatterns("/article/query"); //排除/article/query 请求
LoginInterceptor loginInterceptor = new LoginInterceptor();
registry.addInterceptor(loginInterceptor)
.order(1)
.addPathPatterns("/**") //拦截所有请求
.excludePathPatterns("/article/query"); //排除/article/query 请求
}
//异步请求
default void configureAsyncSupport(AsyncSupportConfigurer configurer) {
}
//帮助配置 HandlerMapping
default void configurePathMatch(PathMatchConfigurer configurer) {
}
//处理内容协商
default void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
}
//配置内容转换器
default void addFormatters(FormatterRegistry registry) {
}
//处理静态资源
default void addResourceHandlers(ResourceHandlerRegistry registry) {
}
//配置全局跨域
default void addCorsMappings(CorsRegistry registry) {
}
//配置视图页面跳转
default void addViewControllers(ViewControllerRegistry registry) {
}
//配置视图解析器
default void configureViewResolvers(ViewResolverRegistry registry) {
}
//自定义参数解析器，处理请求参数
default void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
}
//自定义控制器方法返回值处理器
default void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> handlers) {
}
//配置 HttpMessageConverters
default void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
}
//配置 HttpMessageConverters
default void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
}
//配置异常处理器
default void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
}
//扩展异常处理器
default void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
}
//JSR303 的自定义验证器
default Validator getValidator() {
return null;
}
//消息处理对象
default MessageCodesResolver getMessageCodesResolver() {
return null;
}
//配置异常映射
/*@Override
public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
SimpleMappingExceptionResolver exceptionResolver = new SimpleMappingExceptionResolver();
Properties prop = new Properties();
prop.setProperty("java.lang.ArithmeticException", "error");
//设置异常映射
exceptionResolver.setExceptionMappings(prop);
//设置共享异常信息的键
exceptionResolver.setExceptionAttribute("ex");
resolvers.add(exceptionResolver);
}*/
//配置生成模板解析器
@Bean
public ITemplateResolver templateResolver() {
WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
// ServletContextTemplateResolver 需要一个 ServletContext 作为构造参数，可通过 WebApplicationContext 的方法获得
ServletContextTemplateResolver templateResolver = new ServletContextTemplateResolver(
webApplicationContext.getServletContext());
templateResolver.setPrefix("/WEB-INF/templates/");
templateResolver.setSuffix(".html");
templateResolver.setCharacterEncoding("UTF-8");
templateResolver.setTemplateMode(TemplateMode.HTML);
return templateResolver;
}
//生成模板引擎并为模板引擎注入模板解析器
@Bean
public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
SpringTemplateEngine templateEngine = new SpringTemplateEngine();
templateEngine.setTemplateResolver(templateResolver);
return templateEngine;
}
//生成视图解析器并未解析器注入模板引擎
@Bean
public ViewResolver viewResolver(SpringTemplateEngine templateEngine) {
ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
viewResolver.setCharacterEncoding("UTF-8");
viewResolver.setTemplateEngine(templateEngine);
return viewResolver;
}
}4 测试功能
@RequestMapping("/")
public String index(){
return "index";
}5 WebMvcConfigurer 中其他配置解释
5.1 数据格式化 TODO
Formatter<\T>是数据转换接口，将一种数据类型转换为另一种数据类型。与 Formatter<\T>功能类型的还有 Converter<\S，\T>。本节研究 Formatter<\T>接口。Formatter<\T>只能将 String 类型转为其他数据数据类型。这点在 Web 应用适用更广。因为 Web 请求的所有参数都是 String，我们需要把 String 转为 Integer ，Long，Date 等等。
Spring 中内置了一下 Formatter<\T>：
- DateFormatter ： String 和 Date 之间的解析与格式化
- InetAddressFormatter ：String 和 InetAddress 之间的解析与格式化
- PercentStyleFormatter ：String 和 Number 之间的解析与格式化，带货币符合
- NumberFormat ：String 和 Number 之间的解析与格式化
我在使用@ DateTimeFormat , @NumberFormat 注解时，就是通过 Formatter<\T>解析 String 类型到我们期望的 Date 或 Number 类型
Formatter<\T>也是 Spring 的扩展点，我们处理特殊格式的请求数据时，能够自定义合适的 Formatter<\T>，将请求的 String 数据转为我们的某个对象，使用这个对象更方便我们的后续编码。
接口原型
public interface Formatter<\T> extends Printer<\T>, Parser<\T> {}Formatter<\T>是一个组合接口，没有自己的方法。内容来自 Printer<\T>和 Parser<\T>
Printer<\T>：将 T 类型转为 String，格式化输出
Parser<\T>：将 String 类型转为期望的 T 对象。
我们项目开发，可能面对多种类型的项目，复杂程度有简单，有难一些。特别是与硬件打交道的项目，数据的格式与一般的 name: lisi, age:20 不同。数据可能是一串“1111; 2222; 333,NF; 4; 561” 。
需求：将“1111；2222；333,NF；4；561”接受，代码中用 DeviceInfo 存储参数值。
step1:创建 DeviceInfo 数据类
@Data
public class DeviceInfo {
private String item1;
private String item2;
private String item3;
private String item4;
private String item5;
}step2：自定义 Formatter
public class DeviceFormatter implements Formatter<DeviceInfo> {
//将String数据，转为DeviceInfo
@Override
public DeviceInfo parse(String text, Locale locale) throws ParseException {
DeviceInfo info = null;
if (StringUtils.hasLength(text)) {
String[] items = text.split(";");
info = new DeviceInfo();
info.setItem1(items[0]);
info.setItem2(items[1]);
info.setItem3(items[2]);
info.setItem4(items[3]);
info.setItem5(items[4]);
}
return info;
}
//将DeviceInfo转为String
@Override
public String print(DeviceInfo object, Locale locale) {
StringJoiner joiner = new StringJoiner("#");
joiner.add(object.getItem1()).add(object.getItem2());
return joiner.toString();
}
}step3: 登记自定义的 DeviceFormatter
addFormatters() 方法登记 Formatter
@Configuration
public class MvcSettings implements WebMvcConfigurer {
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/welcome").setViewName("index");
}
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addFormatter(new DeviceFormatter());
}
}step4: 新建 Controller 接受请求设备数据
@RestController
public class DeviceController {
@PostMapping("/device/add")
public String AddDevice(@RequestParam("device") DeviceInfo deviceInfo){
return "接收到的设备数据："+deviceInfo.toString();
}
}step5:单元测试
POST http://localhost:8080/device/add
Content-Type: application/x-www-form-urlencoded
device=1111;2222;333,NF;4;561