【Java从0到架构师】SSM 整合（XML、纯注解）

红太狼 2022-09-04 00:47 165阅读 0赞

### SSM 整合 ###

*  父子容器
 *   *  父子容器的配置文件建议
     *  子容器的加载创建
     *  父容器的加载创建
 *  MyBatis 补充
 *   *  mybatis-config.xml
 *  Maven 补充
 *  SSM 整合 - 纯注解
 *   *  Initializer 取代 web.xml
     *  SpringConfig
     *  SpringMVCConfig
     *   *  Interceptor - 添加拦截器
         *  ViewResolver - 添加视图解析器
         *  MultipartResolver - 添加 multipart 参数解析
         *  Converter - 类型转换器
         *  MessageConverters - 解决编码问题
         *  DefaultServletHandler

> Java 从 0 到架构师目录：[【Java从0到架构师】学习记录][Java_0]

Gitee 代码：[https://gitee.com/szluyu99/mj\_java\_frame/tree/master/03\_SpringMVC][https_gitee.com_szluyu99_mj_java_frame_tree_master_03_SpringMVC]

--------------------

本章涉及的完整代码：[SSM 整合 - XML 示例代码][SSM _ - XML]

> 前面学习过 [Spring + MyBatis 的整合][Spring _ MyBatis]，还需要整合 SpringMVC

# 父子容器 #

SpringMVC 本身属于 Spring 的一部分？还需要做整合操作？

*  需要！

目前存在的问题：所有的 bean 都存储在同一个 IoC 容器中

*  无法避免在 service 注入 controller 等问题
 *  …

解决方案：父子容器

--------------------

![在这里插入图片描述][1d96f879fb064690b3e88e4a5f9ce812.png]  
特点：

*  父容器和子容器是相互隔离的，它们内部可以存在名称相同的 bean
 *  **子容器可以访问父容器中的 bean，而父容器不能访问子容器的 bean**
 *  调用子容器的 getBean 方法，会沿着当前容器向父容器进行查找，直到找到对应的 bean 为止
 *  **子容器中可以通过注入父容器中的 bean，而父容器中无法注入子容器中的 bean**

优点：

*  采用父子容器可以避免依赖层次混乱（service 注入 controller）
 *  将相互不关心的东西隔开，可以有效避免一些不必要的错误，而父子容器加载的速度也会快一些

## 父子容器的配置文件建议 ##

**子容器**的配置文件：[dispatcherServlet.xml][]

*  **controller**、SpringMVC 专用的一些 bean

<context:component-scan base-package="com.mj.controller"/>

**父容器**的配置文件：[applicationContext.xml][]

*  service、dao、其他（非 SpringMVC 专用的 bean，共用的 bean 等）

<context:component-scan base-package="com.mj.service"/>

## 子容器的加载创建 ##

在 [web.xml][] 中配置：

<servlet>
        <servlet-name>DispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            
            <param-value>classpath:dispatcherServlet.xml</param-value>
        </init-param>
        <load-on-startup>0</load-on-startup>
    </servlet>
    
    <servlet-mapping>
        <servlet-name>DispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

## 父容器的加载创建 ##

在 [web.xml][] 中配置：

<context-param>
        <param-name>contextConfigLocation</param-name>
        
        <param-value>classpath:applicationContext.xml</param-value>
    </context-param>
    
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

# MyBatis 补充 #

如果将 Mapper 文件跟 dao 放在相同目录下，且文件名跟 dao 一样：

*  那么通过 MapperScannerConfigurer 就可以找到 Mapper 文件
 *  不需要再配置 SqlSessionFactoryBean 的 mapperLocations 属性  
    ![在这里插入图片描述][3bf2d8cf07904b94bd2066d6104abb4f.png]

可以设置 SqlSessionFactoryBean 的 configLocation 属性，指定 MyBatis 核心配置文件的位置

<property name="configLocation" value="classpath:mybatis-config.xml"/>

## mybatis-config.xml ##

如果对于 mybatis 有些设置需要进行配置，还是需要写到 mybatis-config.xml 中，再在 Spring 中读取：

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
    <configuration>
        <settings>
            <setting name="mapUnderscoreToCamelCase" value="true"/>
        </settings>
    </configuration>

# Maven 补充 #

默认情况下，Maven 并不会将源代码文件夹中的配置文件（propertis，xml 等）打包

若想打包源代码文件夹中的配置文件，需要进行额外的配置：

<build>
        <resources> 
            <resource> 
                <directory>src/main/resources</directory>
            </resource>
            <resource> 
                <directory>src/main/java</directory>
                <includes> 
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>
    </build>

# SSM 整合 - 纯注解 #

## Initializer 取代 web.xml ##

新建一个类，继承 AbstractAnnotationConfigDispatcherServletInitializer：[示例代码][Link 1]

public class WebInitializer extends AbstractAnnotationConfigDispatcherServletInitializer { 
        /** * 父容器的配置类 */
        @Override
        protected Class<?>[] getRootConfigClasses() { 
            return new Class[]{ SpringConfig.class};
        }
    
        /** * 子容器的配置类(SpringMVC相关的配置类) */
        @Override
        protected Class<?>[] getServletConfigClasses() { 
            return new Class[]{ SpringMVCConfig.class};
        }
    
        /** * 配置DispatcherServlet的url-pattern */
        @Override
        protected String[] getServletMappings() { 
            return new String[]{ "/"};
        }
        @Override
        public void onStartup(ServletContext servletContext) throws ServletException { 
        	// 需要调用super
            super.onStartup(servletContext);
    
            // 添加Filter
            FilterRegistration.Dynamic encodingFilter = servletContext.addFilter(
            		"CharacterEncodingFilter", 
            		CharacterEncodingFilter.class);
          	encodingFilter.setInitParameter("encoding", "UTF-8");
            encodingFilter.addMappingForUrlPatterns(null, false, "/*");
        }
    
    }

AbstractAnnotationConfigDispatcherServletInitializer 的本质：

*  最终是实现了 WebApplicationInitializer 接口
 *  项目部署到 web 容器时，会初始化实现了 WebApplicationInitializer 接口的实例，并调用它的 onStartup 方法

实现 WebApplicationInitializer 接口：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]

## SpringConfig ##

SpringConfig 可以不需要再写 `@Configuration`：[示例代码][Link 2]

@ComponentScan("com.mj.service")
    @EnableWebMvc								
    public class SpringConfig { 
    }

## SpringMVCConfig ##

SpringMVCConfig 可以不需要再写 `@Configuration`：[示例代码][Link 3]

@ComponentScan("com.mj.service")
    public class SpringMVCConfig { 
    }

### Interceptor - 添加拦截器 ###

@Autowired
    private MyInterceptor myInterceptor;
    
    /** * 添加拦截器，相当于 <mvc:interceptors> */
    @Override
    public void addInterceptors(InterceptorRegistry registry) { 
        registry.addInterceptor(myInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/asset/**");
    }

### ViewResolver - 添加视图解析器 ###

@Bean
    public InternalResourceViewResolver viewResolver() { 
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix("/WEB-INF/page/"); // 前缀
        resolver.setSuffix(".jsp"); // 后缀
        return resolver;
    }

### MultipartResolver - 添加 multipart 参数解析 ###

需要依赖：

<dependency>
        <groupId>commons-fileupload</groupId>
        <artifactId>commons-fileupload</artifactId>
        <version>1.4</version>
    </dependency>

@Bean
    public CommonsMultipartResolver multipartResolver() { 
        CommonsMultipartResolver resolver = new CommonsMultipartResolver();
        resolver.setDefaultEncoding("UTF-8");
        return resolver;
    }

### Converter - 类型转换器 ###

可以添加一个时间转换器，实现对前端传来的任意格式的时间字符串进行解析：

@Autowired
    private DateConverter dateConverter;
    
    @Override
    public void addFormatters(FormatterRegistry registry) { 
        registry.addConverter(dateConverter);
    }

@Component
    public class DateConverter implements Converter<String, Date> { 
        @Override
        public Date convert(String source) { 
            try { 
                return new SimpleDateFormat("yyyy-MM-dd").parse(source);
            } catch (ParseException e) { 
                e.printStackTrace();
                return null;
            }
        }
    }

### MessageConverters - 解决编码问题 ###

取代了 XML 中的：`<mvc:message-converters>`

/** * 相当于 <mvc:message-converters> */
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) { 
        // 设置返回的普通字符串的编码
        StringHttpMessageConverter stringConverter = new StringHttpMessageConverter();
        stringConverter.setDefaultCharset(StandardCharsets.UTF_8);
        converters.add(stringConverter);
    
        // 设置返回的JSON数据的编码
        MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
        jsonConverter.setDefaultCharset(StandardCharsets.UTF_8);
        converters.add(jsonConverter);
    }

### DefaultServletHandler ###

取代了 XML 配置中的：`<mvc:default-servlet-handler/>`

/** * 相当于<mvc:default-servlet-handler/> * 用以处理静态资源 */
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) { 
        configurer.enable();
    }

[Java_0]: https://blog.csdn.net/weixin_43734095/article/details/119067034
[https_gitee.com_szluyu99_mj_java_frame_tree_master_03_SpringMVC]: https://gitee.com/szluyu99/mj_java_frame/tree/master/03_SpringMVC
[SSM _ - XML]: https://gitee.com/szluyu99/mj_java_frame/tree/master/03_SpringMVC/36_SSM01_XML
[Spring _ MyBatis]: https://blog.csdn.net/weixin_43734095/article/details/119361092
[1d96f879fb064690b3e88e4a5f9ce812.png]: /images/20220829/630e09e76fa041ca9485828ae2f2c80c.png
[dispatcherServlet.xml]: https://gitee.com/szluyu99/mj_java_frame/blob/master/03_SpringMVC/36_SSM01_XML/src/main/resources/dispatcherServlet.xml
[applicationContext.xml]: https://gitee.com/szluyu99/mj_java_frame/blob/master/03_SpringMVC/36_SSM01_XML/src/main/resources/applicationContext.xml
[web.xml]: https://gitee.com/szluyu99/mj_java_frame/blob/master/03_SpringMVC/36_SSM01_XML/src/main/webapp/WEB-INF/web.xml
[3bf2d8cf07904b94bd2066d6104abb4f.png]: /images/20220829/6d25fb4c7eea440ea9d421e3cf4a49e8.png
[Link 1]: https://gitee.com/szluyu99/mj_java_frame/blob/master/03_SpringMVC/37_SSM02_%E7%BA%AF%E6%B3%A8%E8%A7%A3/src/main/java/com/mj/cfg/WebInitializer.java
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]: /images/20220829/fd0667695d254ea5805cca95ee785836.png
[Link 2]: https://gitee.com/szluyu99/mj_java_frame/blob/master/03_SpringMVC/37_SSM02_%E7%BA%AF%E6%B3%A8%E8%A7%A3/src/main/java/com/mj/cfg/SpringConfig.java
[Link 3]: https://gitee.com/szluyu99/mj_java_frame/blob/master/03_SpringMVC/37_SSM02_%E7%BA%AF%E6%B3%A8%E8%A7%A3/src/main/java/com/mj/cfg/SpringMVCConfig.java