SSM整合之使用配置类替换xml配置文件(2)
SSM整合就是将MVC三层架构和框架核心API组件交给SpringIoC容器管理!
一般需要配置两个IoC容器进行三层架构组件管理。
容器名 | 盛放组件 |
---|---|
web容器 | web相关组件(controller,springmvc核心组件) |
root容器 | 业务和持久层相关组件(service,aop,tx,dataSource,mybatis,mapper等) |
web容器是root容器的子容器,父子容器关系。
父容器:root容器,盛放service、mapper、mybatis等相关组件
子容器:web容器,盛放controller、web相关组件
根据MVC三层架构配置三个配置类:
配置名 | 对应内容 | 对应容器 |
---|---|---|
SpringMvcConfig | controller,springmvc相关 | web容器 |
SpringConfig | service,aop,tx相关 | root容器 |
MapperConfig | mapper,datasource,mybatis相关 | root容器 |
配置演示
控制层配置(SpringMVC)
主要配置Web工程的controller层配置
@Configurable
@ComponentScan(basePackages = {"com.evan.controller","com.evan.exceptionhandler"})
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {
//开启静态资源访问
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
//视图解析器
@Override
public void configureViewResolvers(ViewResolverRegistry registry) {
registry.jsp("/WEB-INF/views","jsp");
}
//配置视图控制器
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/")
.setStatusCode(HttpStatusCode.valueOf(200))
.setViewName("index");
}
}
业务层组件配置(Spring)
主要配置service,注解aop和声明事务相关配置
@Configurable
@ComponentScan(basePackages = {"com.evan.service"})
@EnableAspectJAutoProxy
@EnableTransactionManagement
public class SpringConfig {
//配置事务管理器
@Bean
public TransactionManager transactionManager(DataSource dataSource) {
DataSourceTransactionManager transactionManager = new DataSourceTransactionManager();
transactionManager.setDataSource(dataSource);
return transactionManager;
}
}
持久层配置(MyBatis)
主要配置mapper代理对象,连接池和mybatis核心组件配置
外部数据库连接配置文件
jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.username=root
jdbc.password=******
jdbc.url=jdbc://mysql://localhost:3306/dbtest1?serverTimezone=GMT%2B8&characterEncoding=utf-8
配置方式1(保留mybatis-config.xml)
依然保留mybatis的外部配置文件(xml), 但是数据库连接信息交给Druid连接池配置!
缺点:依然需要mybatis-config.xml文件,进行xml文件解析,效率偏低!
mybatis-config.xml
数据库信息以及mapper扫描包设置使用Java配置类处理!
mybatis其他的功能(别名、settings、插件等信息)依然在mybatis-config.xml配置!
<?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"/>
<!-- 开启logback日志输出-->
<setting name="logImpl" value="SLF4J"/>
<!--开启resultMap自动映射 -->
<setting name="autoMappingBehavior" value="FULL"/>
</settings>
<typeAliases>
<!-- 给实体类起别名 -->
<package name="com.evan.bean"/>
</typeAliases>
<plugins>
<plugin interceptor="com.github.pagehelper.PageInterceptor">
<!--
helperDialect:分页插件会自动检测当前的数据库链接,自动选择合适的分页方式。
你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时,可以使用下面的缩写值:
oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby
(完整内容看 PageAutoDialect) 特别注意:使用 SqlServer2012 数据库时,
https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md#%E5%A6%82%E4%BD%95%E9%85%8D%E7%BD%AE%E6%95%B0%E6%8D%AE%E5%BA%93%E6%96%B9%E8%A8%80
-->
<property name="helperDialect" value="mysql"/>
</plugin>
</plugins>
</configuration>
持久层配置类
/**
* @Author: lisong
* @CreateTime: 2024-03-03 18:41 星期日
* @Description:
*/
@Configurable
public class MyBatisConfig {
//配置用于创建SqlSessionFactory的工厂bean
@Bean
public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) {
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
// 设置数据源
sqlSessionFactoryBean.setDataSource(dataSource);
// 设置MyBatis配置文件的路径
Resource resource = new ClassPathResource("mybatis-config.xml");
sqlSessionFactoryBean.setMapperLocations(resource);
//设置实体类对象别名
sqlSessionFactoryBean.setTypeAliasesPackage("com.evan.bean");
return sqlSessionFactoryBean;
}
/**
* 配置mapper接口的扫描配置
* 由mybatis-spring提供,可以将指定包下所有的mapper接口创建动态代理
* 并将这些动态代理作为IOC容器的bean管理
* @return
*/
@Bean
public MapperScannerConfigurer mapperScannerConfigurer() {
MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
//设置mapper接口和xml文件所在的共同包
mapperScannerConfigurer.setBasePackage("com.evan.mapper");
return mapperScannerConfigurer;
}
}
说明:
在Spring配置类中添加了sqlSessionFactoryBean
、mapperScannerConfigurer
和datasource
配置方法时,可能会导致@Value
注解读取不到值为null的问题。
这是因为SqlSessionFactoryBean
和MapperScannerConfigurer
是基于MyBatis框架的配置,它们的初始化顺序可能会导致属性注入的问题。
SqlSessionFactoryBean
和MapperScannerConfigurer
在配置类中通常是用来配置MyBatis相关的Bean,例如数据源、事务管理器、Mapper扫描等。这些配置类通常在@Configuration
注解下定义,并且使用@Value
注解来注入属性值。
当配置类被加载时,Spring容器会首先处理Bean的定义和初始化,其中包括sqlSessionFactoryBean
和mapperScannerConfigurer
的初始化。在这个过程中,如果@Value
注解所在的Bean还没有被完全初始化,可能会导致注入的属性值为null。
解决方案:
分成两个配置类独立配置,互不影响,数据库提取一个配置类,mybatis提取一个配置类即可解决!
数据库配置类
@Configurable
@PropertySource("classpath:jdbc.properties")
public class DataSourceConfig {
@Value("${jdbc.url}")
private String url;
@Value("${jdbc.driver}")
private String driver;
@Value("${jdbc.username}")
private String username;
@Value("${jdbc.password}")
private String password;
//配置数据源
@Bean
public DataSource dataSource() {
DruidDataSource dataSource = new DruidDataSource();
dataSource.setDriverClassName(driver);
dataSource.setUrl(url);
dataSource.setUsername(username);
dataSource.setPassword(password);
return dataSource;
}
}
配置方式2(完全配置类,去掉mybatis-config.xml)
不在保留mybatis的外部配置文件(xml), 所有配置信息(settings、插件、别名等)全部在声明SqlSessionFactoryBean的代码中指定!数据库信息依然使用DruidDataSource实例替代!
优势:全部配置类,避免了XML文件解析效率低问题!
mapper配置类
@Configurable
public class MapperConfig {
//配置用于创建SqlSessionFactory的工厂bean
@Bean
public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) {
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
sqlSessionFactoryBean.setDataSource(dataSource);
//Resource resource = new ClassPathResource("mybatis-config.xml");
//sqlSessionFactoryBean.setMapperLocations(resource);
//全局配置项,不要导错包
//org.apache.ibatis.session.Configuration
Configuration configuration = new Configuration();
//开启驼峰式映射
configuration.setMapUnderscoreToCamelCase(true);
//开启logback日志输出
configuration.setLogImpl(Slf4jImpl.class);
//开启resultMap自动映射
configuration.setAutoMappingBehavior(AutoMappingBehavior.FULL);
sqlSessionFactoryBean.setConfiguration(configuration);
//实体类对象别名设置
sqlSessionFactoryBean.setTypeAliasesPackage("com.evan.bean");
//分页插件配置
PageInterceptor pageInterceptor = getPageInterceptor();
sqlSessionFactoryBean.addPlugins(pageInterceptor);
return sqlSessionFactoryBean;
}
//分页插件配置信息
private static PageInterceptor getPageInterceptor() {
PageInterceptor pageInterceptor = new PageInterceptor();
Properties properties = new Properties();
/*
helperDialect:分页插件会自动检测当前的数据库链接,自动选择合适的分页方式。
你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时,可以使用下面的缩写值:
oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby
(完整内容看 PageAutoDialect) 特别注意:使用 SqlServer2012 数据库时,
https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md#%E5%A6%82%E4%BD%95%E9%85%8D%E7%BD%AE%E6%95%B0%E6%8D%AE%E5%BA%93%E6%96%B9%E8%A8%80
*/
properties.setProperty("helperDialect","mysql");
pageInterceptor.setProperties(properties);
return pageInterceptor;
}
//配置Mapper实例扫描工厂,配置扫描package需要接口和mapper.xml文件同一个包
@Bean
public MapperScannerConfigurer mapperScannerConfigurer() {
MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
//设置mapper接口和xml文件所在的共同包
mapperScannerConfigurer.setBasePackage("com.evan.mapper");
return mapperScannerConfigurer;
}
}
配置web项目初始化类
public class WebInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
//指定root IoC容器的配置类
@Override
protected Class<?>[] getRootConfigClasses() {
return new Class[]{SpringConfig.class, MyBatisConfig.class, DataSourceConfig.class};
}
//指定web IoC容器的配置类
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class[]{SpringMvcConfig.class};
}
//DispatcherServlet请求分发的匹配路径
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
}
图解配置类和容器配置: