mybatis 基础 ~ Hello World

搭建环境

        第一步，引入依赖，分为两个部分

        第一部分，mybatis的核心类库，数据库的jar包，这里使用mysql。

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.6</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.30</version>
</dependency>

        第二部分，代码生成器的类库。

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.7</version>
</dependency>
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper</artifactId>
    <version>4.1.5</version>
</dependency>

        第二步，建立maven项目，略。 

        第三步，编写生成代码的配置文件。注：MyCommentGenerator原生jar包中不存在，可以在网上搜索

<?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>
    <!-- 本地数据库驱动程序jar包的全路径 -->
    <classPathEntry location="A:\code\Java\maven\repo\mysql\mysql-connector-java\8.0.30\mysql-connector-java-8.0.30.jar" />
    <classPathEntry location="A:\code\Java\maven\repo\tk\mybatis\mapper-generator\1.1.5\mapper-generator-1.1.5.jar" />
    <!-- 配置上下文 -->
    <context id="context" defaultModelType="conditional" targetRuntime="MyBatis3">
        <!-- 配置property属性 -->
        <property name="autoDelimitKeywords" value="false" />
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8" />
        <!-- 格式化java代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter" />
        <!-- 格式化XML代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter" />
        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
        <property name="beginningDelimiter" value="`" />
        <property name="endingDelimiter" value="`" />
 
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper" />
            <property name="caseSensitive" value="true" />
            <property name="forceAnnotation" value="true" />
            <property name="beginningDelimiter" value="`" />
            <property name="endingDelimiter" value="`" />
        </plugin>
 
        <!-- 配置生成注解的方式 -->
        <commentGenerator type="org.mybatis.generator.api.MyCommentGenerator">
            <!-- <property name="suppressAllComments" value="true"/> <property name="addRemarkComments" value="false"/> <property name="suppressDate" value="true"/> -->
        </commentGenerator>
 
        <!-- 数据库的相关配置 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/personal?characterEncoding=UTF-8" userId="用户名" password="密码" />
        <!-- 类型处理器 -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>
 
        <!-- 实体类生成的位置 -->
        <javaModelGenerator targetPackage="com.model" targetProject="B:\LearningMybatis\src\main\java">
            <property name="enableSubPackages" value="true" />
            <!-- 在insert字段时，此值会自动对字符串进行trim -->
            <property name="trimStrings" value="true" />
            <!--此值设置为true时不生成set方法 -->
            <property name="immutable" value="false" />
        </javaModelGenerator>
 
        <!-- *Mapper.xml 文件的位置 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="B:\LearningMybatis\src\main\java\resources\mapper">
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>
 
        <!-- Mapper 接口文件的位置 -->
        <javaClientGenerator targetPackage="com.mapper" targetProject="B:\LearningMybatis\src\main\java" type="XMLMAPPER">
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>
 
        <!-- 相关表的配置 -->
        <table tableName="day" enableCountByExample="false" enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false">
            <!-- 在insert语句前自动生成selectKey标签 -->
            <generatedKey column="ID" sqlStatement="MySql" identity="true" />
        </table>
    </context>
</generatorConfiguration>

        第四步，编写mybatis-config配置文件，配置数据源，mapper的位置。 

<?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>
    <typeAliases>
        <typeAlias alias="Weight" type="com.model.Weight"/>
    </typeAliases>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/personal"/>
                <property name="username" value="用户名"/>
                <property name="password" value="密码"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="mapper/DayMapper.xml"/>
    </mappers>
</configuration>

        第五步，编写Hello World示例，验证。

示例

        目标：从任意表中执行增，删，改，查操作，这里只实现查询。

        前提条件：

1. 已安装mysql数据库，
2. 已创建Day表，字段year,month,day。含义分别是年，月，日。
3. 代码已经生成。

         第一步，创建SqlSessionFactory对象，获取SqlSession对象，两种方式。

        配置方式：

InputStream input = Resources.getResourceAsStream("mybatis-config.xml");
sqlSessionFactory = new SqlSessionFactoryBuilder().build(input);

      程序方式：

// 第一步，创建数据源
MysqlDataSource dataSource = new MysqlDataSource();
dataSource.setURL("数据库地址");
dataSource.setUser("用户名");
dataSource.setPassword("密码");
// 第二步，创建事务
TransactionFactory transactionFactory = new JdbcTransactionFactory();
// 第三步，创建Environment对象，与配置文件中的<environment>等同
Environment environment = new Environment("development", transactionFactory, dataSource);
// 第四步，创建Configuration对象，可以添加任意配置
Configuration configuration = new Configuration(environment);
configuration.addMapper(DayMapper.class);
// 第五步，创建SqlSessionFactory对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

        第二步，在mybatis-config.xml中添加DayMapper.xml，程序方式也可以。

        第三步，编写查询程序。

// 1.第一步, 获取SqlSession，相当于创建会话
SqlSession sqlSession = SqlSessionUtil.openSession();
// 2. 获取对应的Mapper对象
DayMapper mapper = null;
try {
    mapper = sqlSession.getMapper(DayMapper.class);
    List<Day> days = mapper.test();
    days.stream().forEach((current) -> {
        System.out.println(current.getYear() + "-" + current.getMonth() + "-" + current.getDay());
    });
} catch (Exception e) {
    e.printStackTrace();
} finally {
    sqlSession.close();
}

        第四步，编写测试单元，调用查询方法，略。