以注解的方式整合spring与myBatis

绝地灬酷狼 2024-02-19 20:20 67阅读 0赞

***【感谢所有的批评与提问，你们让我进步和更专业】***

网上有很多SSM框架整合的案例，但是大部分都是基于xml的方式去整合的，所以我就想与注解的方式实现Spring与myBatis的整合！

1.项目的目录结构是这样的(在博客中没有提及的类就是没有用到的，同时我们也可以吧log4j文件去了，因为在这个项目中我并没有用到切面，所以日志文件也没啥用)：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW9saXViYW8x_size_16_color_FFFFFF_t_70][]

2.pom配置如下：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.zlb.springaop</groupId>
        <artifactId>spring-aop</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <dependencies>
            
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>5.1.8.RELEASE</version>
            </dependency>
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>5.1.8.RELEASE</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-beans</artifactId>
                <version>5.1.8.RELEASE</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>5.1.8.RELEASE</version>
            </dependency>
    
            
            
            <dependency>
                <groupId>aopalliance</groupId>
                <artifactId>aopalliance</artifactId>
                <version>1.0</version>
            </dependency>
            
            <dependency>
                <groupId>aspectj</groupId>
                <artifactId>aspectjrt</artifactId>
                <version>1.5.4</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.aspectj</groupId>
                <artifactId>aspectjweaver</artifactId>
                <version>1.9.4</version>
            </dependency>
    
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
    
            
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis-spring</artifactId>
                <version>2.0.1</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-jdbc</artifactId>
                <version>5.1.8.RELEASE</version>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.16</version>
            </dependency>
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.5.1</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.17</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.8</version>
                <scope>provided</scope>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency> 
        </dependencies>
    
    </project>

3.log4j文件如下（可以不要）：

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
    <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
    
    	<appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
    		<layout class="org.apache.log4j.PatternLayout">
    			<param name="ConversionPattern" value="[%p][%d{ISO8601}][%t][%c][%m]%n" />
    		</layout>
    	</appender>
    
    	
    	<appender name="DEBUG" class="org.apache.log4j.RollingFileAppender">
    		
    		<param name="File" value="springaop/log/debug/app-debug.log" />
    		
    		<param name="Append" value="true" />
    		
    		
    		<param name="MaxFileSize" value="30MB" />
    		
    		<param name="MaxBackupIndex" value="30" />
    		
    		<param name="Encoding" value="UTF8" />
    		
    		<layout class="org.apache.log4j.PatternLayout">
    			<param name="ConversionPattern" value="[%p][%d{ISO8601}][%t][%c][%m]%n" />
    		</layout>
    		
    		
    		<filter class="org.apache.log4j.varia.LevelRangeFilter">
    			<param name="LevelMin" value="DEBUG" />
    			<param name="LevelMax" value="DEBUG" />
    		</filter>
    	</appender>
    
    	<appender name="INFO" class="org.apache.log4j.RollingFileAppender">
    		<param name="File" value="springaop/log/debug/app-debug.log" />
    		
    		<param name="Append" value="true" />
    		<param name="MaxFileSize" value="30MB" />
    		<param name="MaxBackupIndex" value="30" />
    		<param name="Encoding" value="UTF8" />
    		<layout class="org.apache.log4j.PatternLayout">
    			<param name="ConversionPattern" value="[%p][%d{ISO8601}][%t][%c][%m]%n" />
    		</layout>
    		<filter class="org.apache.log4j.varia.LevelRangeFilter">
    			<param name="LevelMin" value="INFO" />
    			<param name="LevelMax" value="INFO" />
    		</filter>
    	</appender>
    
    	<appender name="WARN" class="org.apache.log4j.RollingFileAppender">
    		<param name="File" value="springaop/log/debug/app-debug.log" />
    		<param name="Append" value="true" />
    		<param name="MaxFileSize" value="30MB" />
    		<param name="MaxBackupIndex" value="30" />
    		<param name="Encoding" value="UTF8" />
    		<layout class="org.apache.log4j.PatternLayout">
    			<param name="ConversionPattern" value="[%p][%d{ISO8601}][%t][%c][%m]%n" />
    		</layout>
    		<filter class="org.apache.log4j.varia.LevelRangeFilter">
    			<param name="LevelMin" value="WARN" />
    			<param name="LevelMax" value="WARN" />
    		</filter>
    	</appender>
    
    	<appender name="ERROR" class="org.apache.log4j.RollingFileAppender">
    		<param name="File" value="springaop/log/debug/app-debug.log" />
    		
    		<param name="Append" value="true" />
    		<param name="MaxFileSize" value="30MB" />
    		<param name="MaxBackupIndex" value="30" />
    		<param name="Encoding" value="UTF8" />
    		<layout class="org.apache.log4j.PatternLayout">
    			<param name="ConversionPattern" value="[%p][%d{ISO8601}][%t][%c][%m]%n" />
    		</layout>
    		<filter class="org.apache.log4j.varia.LevelRangeFilter">
    			<param name="LevelMin" value="ERROR" />
    			<param name="LevelMax" value="ERROR" />
    		</filter>
    	</appender>
    
    	<logger name="mapper/userMapper.xml">
    		<level value="DEBUG"></level>
    		<appender-ref ref="STDOUT"></appender-ref>
    	</logger>
    	<root>
    		
    		<priority value="INFO" />
    		<appender-ref ref="STDOUT" />
    		<appender-ref ref="DEBUG" />
    		<appender-ref ref="INFO" />
    		<appender-ref ref="WARN" />
    		<appender-ref ref="ERROR" />
    	</root>
    
    </log4j:configuration>

4.applicationContext.xml配置文件如下

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
           xmlns:context="http://www.springframework.org/schema/context"
           xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">
    
        <context:component-scan base-package="com.zlb.spring"/>
    </beans>

一开始我不想用这个配置文件，但是如果不使用这个配置文件，也就是不开启 <context:component-scan base-package="com.zlb.spring"/>注解扫描的话，spring在启动的时候不会将所带有spring相关的注解类添加到spring的ioc容器中，所以也就不会有后续操作了。如果我们不想使用这个配置文件的话，我们就要引入spring的web与mvc模块，将spring启动时加载相关类（spring注解配置的相关类）交给tomcat容器来进行初始化，可以参考[https://www.cnblogs.com/jhxxb/p/10512553.html][https_www.cnblogs.com_jhxxb_p_10512553.html]这篇博客的写法。【这段说法是有问题的：修正如下：只要在任何一个带有@ComponentScan注解的java类上配置好扫描路径，再以注解的方式去获取spring的ioc容器就ok了 <context:component-scan base-package="com.zlb.spring"/>这一段配置其实就相当于：@ComponentScan("com.zlb.spring") 目的就是为了将这个路径下的所有spring能识别的bean装进springIoc容器中，在实际的开发中哪个方便用哪个即可，不过目前很流行使用注解方式，当然也是springboot推荐的方式，因为这种方式的扩展性很强】

5.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="localCacheScope" value="SESSION"/>
        
        <setting name="logImpl" value="STDOUT_LOGGING"/>
        
        <setting name="useColumnLabel" value="true"/>
        
        <setting name="autoMappingBehavior" value="PARTIAL"/>
        
        <setting name="defaultExecutorType" value="SIMPLE"/>
        
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        
        <setting name="jdbcTypeForNull" value="NULL"/>
        
        <setting name="multipleResultSetsEnabled" value="true"/>
        
        <setting name="useGeneratedKeys" value="false"/>
    </settings>
    </configuration>

我觉得：

<setting name="logImpl" value="STDOUT\_LOGGING"/>这段配置相当重要，有了它我们能够更加方便的调试，看到自己的传参等等。

这个配置文件可以不写，不写就使用默认的设置，但是我觉得写比不写好很多，建议要写上。

6.mybatis配置相关类如下：

package com.zlb.spring.aop;
    
            import com.alibaba.druid.pool.DruidDataSource;
            import org.apache.ibatis.session.ExecutorType;
            import org.mybatis.spring.SqlSessionFactoryBean;
            import org.mybatis.spring.SqlSessionTemplate;
            import org.mybatis.spring.mapper.MapperScannerConfigurer;
            import org.springframework.beans.factory.annotation.Value;
            import org.springframework.context.annotation.*;
            import org.springframework.core.io.ClassPathResource;
            import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
            import org.springframework.jdbc.datasource.DataSourceTransactionManager;
            import org.springframework.transaction.annotation.EnableTransactionManagement;
    
            import javax.sql.DataSource;
    
    @Configuration
    @EnableTransactionManagement
    public class LogConfig {
       
        /*获取sqlSession工厂*/
        @Bean
        public SqlSessionFactoryBean getSqlSessionFactoryBean(DataSource dataSource) throws Exception{
            SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
            sqlSessionFactoryBean.setDataSource(dataSource);
            // 设置 MyBatis 配置文件路径
            sqlSessionFactoryBean.setConfigLocation(new ClassPathResource("mybatis-config.xml"));
            // 设置 SQL 映射文件路径
            sqlSessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/*.xml"));
            // 设置 JavaBean 类型别名，在 SQL 映射文件中就不用写全类名
            //sqlSessionFactoryBean.setTypeAliasesPackage("ssm.pojo");
            return sqlSessionFactoryBean;
        }
    
        /* Druid 数据源*/
        @Bean
        public DataSource getDataSource() {
            DruidDataSource dataSource = new DruidDataSource();
            dataSource.setUrl("jdbc:mysql://172.21.13.212/zlb");
            dataSource.setUsername("root");
            dataSource.setPassword("xxxxx");
            return dataSource;
        }
    
        /**
         * 扫描所有 mapper 接口的实现，让这些 mapper 能够自动注入
         */
        @Bean
        public MapperScannerConfigurer getMapperScannerConfigurer() {
            MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
            mapperScannerConfigurer.setBasePackage("com.zlb.spring.dao");
            return mapperScannerConfigurer;
        }
    
        /*开启事务管理*/
        @Bean
        public DataSourceTransactionManager getDataSourceTransactionManager(DataSource dataSource) {
            return new DataSourceTransactionManager(dataSource);
        }
    
        /**
         * 配置一个可以进行批量执行的 sqlSession
         */
        @Bean
        public SqlSessionTemplate getSqlSessionTemplate(SqlSessionFactoryBean sqlSessionFactoryBean) throws Exception {
            /**
             * Simple Executor -- SIMPLE 普通的执行器，默认
             * Reuse Executor -执行器会重用预处理语句（prepared statements）
             * Batch Executor --批量执行器
             */
            SqlSessionTemplate sessionTemplate = new SqlSessionTemplate(sqlSessionFactoryBean.getObject(), ExecutorType.BATCH);
            return sessionTemplate;
        }
    }

7.dao层如下：

package com.zlb.spring.dao;
    
    import com.zlb.spring.model.User;
    import org.springframework.stereotype.Repository;
    
    @Repository
    public interface UserDao {
        User getUser();
    }

8.实体类如下

package com.zlb.spring.model;
    
    import lombok.Data;
    
    @Data
    public class User {
        private  int id ;
        private String name;
        private String address;
        private String idcard;
    
    }

9.测试类如下：

package com.zlb.test;
    
    import com.zlb.spring.dao.UserDao;
    import com.zlb.spring.model.User;
    import org.junit.Test;
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.support.ClassPathXmlApplicationContext;
    
    public class MainTest {
    
        @Test
        public void getUser(){
            ApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
            UserDao userDao = (UserDao) applicationContext.getBean("userDao");
            User user = userDao.getUser();
            System.out.println(user);
        }
    }

10.运行结果如下

Logging initialized using 'class org.apache.ibatis.logging.stdout.StdOutImpl' adapter.
    Creating a new SqlSession
    SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@2bdd8394] was not registered for synchronization because synchronization is not active
    [INFO][2019-07-02 10:46:02,361][main][com.alibaba.druid.pool.DruidDataSource][{dataSource-1} inited]
    JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@6e15fe2] will not be managed by Spring
    ==>  Preparing: select * from users; 
    ==> Parameters: 
    <==    Columns: id, name, address, idcard
    <==        Row: 1, xxx, 云南, 523049616169165xx
    <==      Total: 1
    Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@2bdd8394]
    User(id=1, name=xxx, address=云南, idcard=523049616169165xx)
    
    Process finished with exit code 0

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW9saXViYW8x_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/622fdf315c14431bb04f48b2829f4f10.png
[https_www.cnblogs.com_jhxxb_p_10512553.html]: https://www.cnblogs.com/jhxxb/p/10512553.html