【Mybatis】Springboot整合Mybatis

整合Mybatis以及Mybatis-generator后项目结构:

具体整合步骤如下:

步骤一:添加jar包依赖

主Module pom中声明相应的jar包版本号

<properties>
    <java.version>1.8</java.version>
    <pro.version>1.0.0</pro.version>
    <mybaits.version>3.4.6</mybaits.version>
    <mybatis.springboot.version>1.3.2</mybatis.springboot.version>
    <mysql.connector.version>8.0.11</mysql.connector.version>
    <tk.mybatis.version>3.3.9</tk.mybatis.version>
    <mybatis.generator.version>1.3.5</mybatis.generator.version>
    <apache.commons.lang3.version>3.7</apache.commons.lang3.version>
</properties>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>${mybaits.version}</version>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>${mybatis.springboot.version}</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>${mysql.connector.version}</version>
</dependency>
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>${mybatis.generator.version}</version>
</dependency>
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>${apache.commons.lang3.version}</version>
</dependency>

子Module (test-dao)pom中添加相应的依赖,以及Mybatis-generator插件

<dependencies>
    <dependency>
        <groupId>com.example</groupId>
        <artifactId>test-common</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>
<build>
    <plugins>
        <!--mybatis自动生成-->
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.5</version>
            <configuration>
                <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
                <overwrite>true</overwrite>
                <verbose>true</verbose>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>${mysql.connector.version}</version>
                </dependency>
                <dependency>
                    <groupId>tk.mybatis</groupId>
                    <artifactId>mapper</artifactId>
                    <version>${tk.mybatis.version}</version>
                </dependency>
                <dependency>
                    <groupId>com.example</groupId>
                    <artifactId>test-common</artifactId>
                    <version>${pro.version}</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

子Module (test-common)pom中添加相应的依赖

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
</dependency>

步骤二、定义mybatis-config.xml

<configuration>
    <!-- 全局参数 -->
    <settings>
        <!-- 全局映射器启用缓存。系统默认值是true,设置只是为了展示出来 -->
        <setting name="cacheEnabled" value="true"/>
        <!-- 查询时,关闭关联对象即时加载以提高性能 -->
        <setting name="lazyLoadingEnabled" value="true"/>
        <!-- 设置关联对象加载的形态,此处为按需加载字段(加载字段由SQL指 定),不会加载关联表的所有字段,以提高性能 -->
        <setting name="aggressiveLazyLoading" value="false"/>
        <!-- 对于未知的SQL查询,允许返回不同的结果集以达到通用的效果 -->
        <setting name="multipleResultSetsEnabled" value="true"/>
        <!-- 允许使用列标签代替列名 -->
        <setting name="useColumnLabel" value="true"/>
        <!-- 允许使用自定义的主键值(比如由程序生成的UUID 32位编码作为键值),数据表的PK生成策略将被覆盖 -->
        <setting name="useGeneratedKeys" value="true"/>
        <!-- 给予被嵌套的resultMap以字段-属性的映射支持(NONE, PARTIAL, FULL) -->
        <setting name="autoMappingBehavior" value="FULL"/>
        <!-- 配置默认的执行器,SIMPLE 执行器没有什么特别之处,REUSE 执行器重用预处理语句,BATCH 执行器重用语句和批量更新 -->
        <setting name="defaultExecutorType" value="REUSE"/>
        <!-- 数据库超过180秒仍未响应则超时 -->
        <setting name="defaultStatementTimeout" value="180"/>
        <!-- 是否启用下划线与驼峰式命名规则的映射(如first_name => firstName) -->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        <setting name="defaultFetchSize" value="200"/>
        <!-- SESSION, STATEMENT -->
        <setting name="localCacheScope" value="SESSION"/>
        <!-- NULL, VARCHAR, OTHER -->
        <setting name="jdbcTypeForNull" value="OTHER" />
        <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString" />
        <setting name="logPrefix" value="[mybatis]" />
        <setting name="logImpl" value="STDOUT_LOGGING" />
    </settings>
</configuration>

步骤三、定义generatorConfig.xml

<generatorConfiguration>

    <context id="mycat_mysql" targetRuntime="MyBatis3" defaultModelType="flat">

        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <commentGenerator type="com.example.test.common.utils.MyCommentGenerator">
            <property name="suppressAllComments" value="false"/>
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3306/test?useSSL=false"
                        userId="test"
                        password="test">
        </jdbcConnection>

        <javaTypeResolver type="com.example.test.common.utils.MyJavaTypeResolverDefaultImpl"/>

        <javaModelGenerator targetPackage="com.example.test.dao.po" targetProject="src/main/java"/>

        <sqlMapGenerator targetPackage="/" targetProject="./src/main/resources/mapper"/>

        <javaClientGenerator targetPackage="com.example.test.dao" targetProject="src/main/java" type="XMLMAPPER"/>

        <table schema="general" tableName="test" domainObjectName="Test"
               enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false"
               enableSelectByExample="false" selectByExampleQueryId="false">
            <property name="useActualColumnNames" value="false"/>
        </table>
    </context>

</generatorConfiguration>

步骤四、定义数据源配置类,包括可以定义事务以及对对mapper接口扫描

/**
 * @Description
 * @Date 19-5-24 上午10:38
 * @Author zz
 */
@Configuration
@EnableTransactionManagement
@MapperScan(value = "com.example.test.dao", sqlSessionFactoryRef = "sqlSessionFactoryBean")
public class DataSourceConfig implements TransactionManagementConfigurer {
    @Value(value = "classpath:*.xml")
    private Resource[] mapperLocation;

    @Value(value = "classpath:mybatis-config.xml")
    private Resource configLocation;

    @Primary
    @Bean(name = "sqlSessionFactoryBean")
    public SqlSessionFactoryBean sqlSessionFactory(@Qualifier("dataSource") DataSource dataSource) {
        SqlSessionFactoryBean ssfb = new SqlSessionFactoryBean();
        ssfb.setDataSource(dataSource);
        ssfb.setMapperLocations(mapperLocation);
        ssfb.setConfigLocation(configLocation);
        ssfb.setTypeAliasesPackage("com.dadaabc.attendance.dao.attendance");
        return ssfb;
    }

    @Primary
    @Bean(name = "dataSource", destroyMethod = "close") //initMethod = "init",
    @ConfigurationProperties(prefix = "spring.datasource.hikari")
    public DataSource dataSource() {
        return DataSourceBuilder.create().type(HikariDataSource.class).build();
    }

    @Override
    public PlatformTransactionManager annotationDrivenTransactionManager() {
        return new DataSourceTransactionManager(dataSource());
    }
}

步骤五、定义类型转换类MyCommentGenerator和MyJavaTypeResolverDefaultImpl

/**
 * @Description 根据db字段注释生成bean也带注释
 * @Date 19-5-24 上午11:07
 * @Author zz
 */
public class MyCommentGenerator extends DefaultCommentGenerator {

    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        // 字段注释
        field.addJavaDocLine("/**");
        if (StringUtils.isNotEmpty(introspectedColumn.getRemarks())){
            field.addJavaDocLine(" * " + introspectedColumn.getRemarks());
        }
        field.addJavaDocLine(" * 表字段:" + introspectedColumn.getActualColumnName());
        field.addJavaDocLine(" */");

    }

    @Override
    public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        // 空,方法无注释
    }

    @Override
    public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        // 空,方法无注释
    }
}
/**
 * @Description 自动指定 db 字段转换Java类型
 * @Date 19-5-24 上午11:03
 * @Author zz
 */
public class MyJavaTypeResolverDefaultImpl extends JavaTypeResolverDefaultImpl {

    public MyJavaTypeResolverDefaultImpl() {
        super();
        //把数据库的 TINYINT 映射成 Integer
        super.typeMap.put(Types.TINYINT, new JdbcTypeInformation("TINYINT", new FullyQualifiedJavaType(Integer.class.getName())));
    }
}

 步骤六、定义相应的po以及mapper文件夹,运行Mybatis-generator插件即可通过数据库表来自动生产相应的dao层文件

步骤七:定义数据库连接

# 端口
server:
  port: 8080

# 数据库连接
spring:
  datasource:
    hikari:
      jdbc-url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&useSSL=false&transformedBitIsBoolean=true&zeroDateTimeBehavior=CONVERT_TO_NULL&serverTimezone=Asia/Shanghai&allowMultiQueries=true
      username: test
      password: test
      driver-class-name: com.mysql.cj.jdbc.Driver
      maximum-pool-size: 15
      pool-name: dada_attendance-db

步骤八、在mapper接口定义中申明一个数据库访问接口(接口使用@Repository注解),在mapper文件夹xml中书写相应的sql语句,然后在test-service子Module中注入使用即可完成test-dao层访问数据库

@Repository
public interface TestMapper {
    int selectCount();
}
<select id="selectCount" resultType="java.lang.Integer">
  select count(1) from test;
</select>

总结:

Springboot整合Mybatis相对而言比较简单,首先就是引入相应jar包,其次定义数据库配置(xml),以及数据源配置(java配置类),然后再定义接口映射文件(*.java、*Mapper.xml),最后在映射文件里写相应sql,并被其它层接口调用。


网上很多文章写的不错,这里记录下主要为了加深印象,公司裁员在即,心慌慌

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值