Mybaties学习笔记(一)
环境 IDEA2021.2.1
Maven 3.8
MyBaties 3.5.2
创建测试工程
项目结构如下
- Maven项目pom.xml文件
这块内容都是自己生成的,不需要修改
<?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>org.example</groupId>
<artifactId>MyBatiesStudy</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>MyBaties1</module>
</modules>
<properties>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>
</project>
- 子模块pom.xml文件
需要修改的地方已用中文注释
<?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">
<parent>
<artifactId>MyBatiesStudy</artifactId>
<groupId>org.example</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>MyBaties1</artifactId>
<dependencies>
<!--该项目所使用到的jar包-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.20</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.5</version>
</dependency>
</dependencies>
<build>
<!--使用maven-generator所使用的插件的jar包-->
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<!--注意artifactId与上面mybatis-generator-core不同-->
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.5</version>
<configuration>
<!--配置文件的位置-->
<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.13</version>
</dependency>
</dependencies>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
<resources>
<!--项目所依赖的配置文件,只有有这个配置,生成的target目录才会把对应的配置文件拷贝进去-->
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
</build>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.encoding>UTF-8</maven.compiler.encoding>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>
</project>
- mybaties-config.xml文件
主要配置一些数据库连接信息,xxxx的地方换成自己的环境,还有要指定mappers.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核心配置文件-->
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<!--连接数据库的一些配置信息-->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<!--注意url的写法,mysql8以上版本和以下版本不同-->
<property name="url" value="jdbc:mysql://xx.xx.xx.xx:xxxx/xxxx?serverTimezone=CTT&characterEncoding=utf8&useUnicode=true&useSSL=false&autoReconnect=true&allowMultiQueries=true"/>
<property name="username" value="xxxx"/>
<property name="password" value="xxxx"/>
</dataSource>
</environment>
</environments>
<!--每一个Mapper.XML都需要在Mybatis核心配置文件中注册! -->
<mappers>
<mapper resource="com/dao/UserMapper.xml"/>
</mappers>
</configuration>
- UserMapper.xml
Mapper主要是绑定sql语句和方法
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<!--绑定dao接口类-->
<mapper namespace="com.dao.BpSubtransMapper">
<!--绑定dao接口类中的方法和数据库类,select是查询,id是方法,resultType是返回类型-->
<select id="getBpSubtransList" resultType="com.pojo.BpSubtrans">
<!--对应查询语句-->
select * from bp_subtrans
</select>
</mapper>
使用Mybaties-generator自动生成数据库类
一般情况下pojo目录下的数据库类需要自己写,不过可以借助Mybaties-generator自动生成
- generatorConfig.xml中内容
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!--mysql 连接数据库jar 这里选择自己本地位置;
如果不知道maven本地仓库地址,可以使用EveryThing工具全局搜索mysql-connector-java,找到jar包位置;
也可以手动下载一个jar放在指定位置,进行引用。
-->
<classPathEntry location="D:\\Maven\\.m2\\repository\\mysql\\mysql-connector-java\\8.0.20\\mysql-connector-java-8.0.20.jar"/>
<context id="testTables" targetRuntime="MyBatis3">
<commentGenerator>
<!-- 是否去除自动生成的注释,true:是,false:否 -->
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--数据库连接的信息:驱动类、连接地址、用户名、密码 -->
<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://10.20.20.126:33061/dbtran?serverTimezone=CTT&characterEncoding=utf8&useUnicode=true&useSSL=false&autoReconnect=true&allowMultiQueries=true"
userId="dbtran"
password="dbtran">
</jdbcConnection>
<!-- 默认false,把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer,为 true时把JDBC DECIMAL 和
NUMERIC 类型解析为java.math.BigDecimal -->
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!-- 指定javaBean生成的位置
targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制;
targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中,如果目录不存在,MBG不会自动建目录
-->
<javaModelGenerator targetPackage="com.pojo" targetProject="src/main/java">
<!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false;如果多个数据库改为true分目录 -->
<property name="enableSubPackages" value="false"/>
<!-- 设置是否在getter方法中,对String类型字段调用trim()方法 -->
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- 指定mapper映射文件生成的位置
targetPackage、targetProject同javaModelGenerator中作用一样-->
<sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<!-- 指定mapper接口生成的位置
targetPackage、targetProject同javaModelGenerator中作用一样
-->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.dao" targetProject="src/main/java">
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
<!-- 指定数据库表
domainObjectName:生成的domain类的名字,当表名和domain类的名字有差异时一定要设置,如果不设置,直接使用表名作为domain类的名字;
可以设置为somepck.domainName,那么会自动把domainName类再放到somepck包里面;
-->
<table tableName="bp_subtrans">
<!--是否使用数据库真实字段,默认false,自动生成的属性名采用驼峰规则-->
<property name="useActualColumnNames" value="true"/>
</table>
</context>
</generatorConfiguration>
- 执行插件命令
会自动生成如下截图文件
注:MyBaties-generator生成的模板说实话不怎么好用,很多需要的代码都没有,看了网上说要用自定义模板规范生成才比较好用。以后有时间再学习
测试实例
这里虽然生成了mapper.xml文件,但是还是选择使用自己的一个简单的例子测试一下,所以选用了UserMapper.xml。因此也,重写了BpSubtransMapper。
- BpSubtransMapper
package com.dao;
import com.pojo.BpSubtrans;
import com.pojo.BpSubtransExample;
import java.util.List;
import org.apache.ibatis.annotations.Param;
public interface BpSubtransMapper {
// long countByExample(BpSubtransExample example);
//
// int deleteByExample(BpSubtransExample example);
//
// int insert(BpSubtrans record);
//
// int insertSelective(BpSubtrans record);
//
// List<BpSubtrans> selectByExample(BpSubtransExample example);
List<BpSubtrans> getBpSubtransList();
// int updateByExampleSelective(@Param("record") BpSubtrans record, @Param("example") BpSubtransExample example);
//
// int updateByExample(@Param("record") BpSubtrans record, @Param("example") BpSubtransExample example);
}
- MybatiesUtils文件
package com.untils;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;
/**
* @program: MyBatiesStudy
* @description:
* @author: lujw32611
* @date: 2021-11-26 11:04
**/
public class MybatiesUtils {
private static SqlSessionFactory sqlSessionFactory;
static{
try {
//使用Mybatis第一步:获取sqlSessionFactory对象
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
//既然有了 SqlSessionFactory,顾名思义,我们就可以从中获得 SqlSession 的实例了。
// SqlSession 完全包含了面向数据库执行 SQL 命令所需的所有方法。
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
- 写一个test用例执行select * form 表显示所有数据
package com.test;
/**
* @program: MyBatiesStudy
* @description:
* @author: lujw32611
* @date: 2021-11-26 15:44
**/
import com.dao.BpSubtransMapper;
import com.pojo.BpSubtrans;
import com.untils.MybatiesUtils;
import org.apache.ibatis.session.SqlSession;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
public class Test {
@org.junit.Test
public void test(){
SqlSession sqlSession = null;
try {
sqlSession = MybatiesUtils.getSqlSession();
BpSubtransMapper mapper = sqlSession.getMapper(BpSubtransMapper.class);
List<BpSubtrans> userList = mapper.getBpSubtransList();
for (BpSubtrans user : userList) {
System.out.println(user);
}
} catch (Exception e) {
e.printStackTrace();
} finally {
if(sqlSession != null){
sqlSession.close();
}
}
}
}