以注解的方式整合spring与myBatis

最新推荐文章于 2022-09-01 20:51:09 发布

Layber

最新推荐文章于 2022-09-01 20:51:09 发布

阅读量593

点赞数 1

文章标签： spring mybatis

本文链接：https://blog.csdn.net/zhaoliubao1/article/details/94431061

版权

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

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

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

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>
        <!--spring核心依赖-->
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.1.8.RELEASE</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-core -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>5.1.8.RELEASE</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-beans -->
        <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>

        <!--sping aop 所必须依赖的jar包-->
        <!-- https://mvnrepository.com/artifact/aopalliance/aopalliance -->
        <dependency>
            <groupId>aopalliance</groupId>
            <artifactId>aopalliance</artifactId>
            <version>1.0</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/aspectj/aspectjrt -->
        <dependency>
            <groupId>aspectj</groupId>
            <artifactId>aspectjrt</artifactId>
            <version>1.5.4</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
        <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>

        <!--spring整合mybatis-->
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis-spring -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>2.0.1</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-jdbc -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.1.8.RELEASE</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.16</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.1</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.17</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <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>

	<!--class定义日志记录器-->
	<appender name="DEBUG" class="org.apache.log4j.RollingFileAppender">
		<!--相对于应用服务器的输出路径,应用服务器的路径指定在common包中指定-->
		<param name="File" value="springaop/log/debug/app-debug.log" />
		<!--是否追加写入文件 true-是 false-否,此部分不建议改动-->
		<param name="Append" value="true" />
		<!--当日志文件超过定义数值则自动备分一个新文件-->
		<!--可以定义为1MB,1KB,1GB这样的类型,也可以定义为1000则表示1000字节-->
		<param name="MaxFileSize" value="30MB" />
		<!--备分文件最多的数量-->
		<param name="MaxBackupIndex" value="30" />
		<!--输出的日志文件格式,根据操作系统编码指定-->
		<param name="Encoding" value="UTF8" />
		<!--log4j的打印日志布局,可参考相关log4j文档设置-->
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="[%p][%d{ISO8601}][%t][%c][%m]%n" />
		</layout>
		<!--日志级别过滤器-->
		<!--LevelMin表示最小的级别,LevelMax表示最大的级别,建议不做改动-->
		<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="File" value="D:/Program Files/log/info/app-info.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="File" value="D:/Program Files/log/error/app-error.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这篇博客的写法。【这段说法是有问题的：修正如下：只要在任何一个带有@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>
    <!-- 本地(一级)缓存作用域，默认 SESSION，会缓存一个会话(SqlSession)中执行的所有查询。 设置为 STATEMENT，会话仅作用在语句执行上，对 SqlSession 的调用将不会共享数据，可认为是禁用一级缓存 -->
    <setting name="localCacheScope" value="SESSION"/>
    <!-- 控制台打印SQL -->
    <setting name="logImpl" value="STDOUT_LOGGING"/>
    <!-- 是否可以使用列的别名 (取决于驱动的兼容性) default:true -->
    <setting name="useColumnLabel" value="true"/>
    <!-- 指定 MyBatis 如何自动映射 数据基表的列 NONE：不隐射　PARTIAL:部分  FULL:全部  -->
    <setting name="autoMappingBehavior" value="PARTIAL"/>
    <!-- 这是默认的执行类型  （SIMPLE: 简单； REUSE: 执行器可能重复使用prepared statements语句；BATCH: 执行器可以重复执行语句和批量更新）  -->
    <setting name="defaultExecutorType" value="SIMPLE"/>
    <!-- 使用驼峰命名法转换字段。 -->
    <setting name="mapUnderscoreToCamelCase" value="true"/>
    <!-- 设置但JDBC类型为空时,某些驱动程序 要指定值,default:OTHER，插入空值时不需要指定类型 -->
    <setting name="jdbcTypeForNull" value="NULL"/>
    <!-- 是否允许单条sql 返回多个数据集  (取决于驱动的兼容性) default:true -->
    <setting name="multipleResultSetsEnabled" value="true"/>
    <!-- 允许JDBC 生成主键。需要驱动器支持。如果设为了true，这个设置将强制使用被生成的主键，有一些驱动器不兼容不过仍然可以执行。  default:false  -->
    <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

Layber

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
5
评论
以注解的方式整合spring与myBatis

【感谢所有的批评与提问，你们让我进步和更专业】网上有很多SSM框架整合的案例，但是大部分都是基于xml的方式去整合的，所以我就想与注解的方式实现Spring与myBatis的整合！1.项目的目录结构是这样的(在博客中没有提及的类就是没有用到的，同时我们也可以吧log4j文件去了，因为在这个项目中我并没有用到切面，所以日志文件也没啥用)：2.pom配置如下：<?xml v...
复制链接

扫一扫