MyBatis框架配置文件整合与解析

MyBatis框架配置文件整合与解析

一、基于配置文件的MyBatis使用

1.1 创建Maven工程

<groupId>org.example</groupId>
<artifactId>20201113-mybatis_demo</artifactId>
<version>1.0-SNAPSHOT</version>

1.2 添加MyBatis坐标

<dependencies>
        <!-- 引入mybatis jar包 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>
        <!-- 单元测试jar包 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
            <scope>test</scope>
        </dependency>
        <!-- MySql数据库连接jar包 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.6</version>
            <scope>runtime</scope>
        </dependency>
        <!-- 日志jar包 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.12</version>
        </dependency>
        <!-- lombok jar包 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.10</version>
            <scope>provided</scope>
        </dependency>
</dependencies>

1.3 编写User实体类

@Data
public class User {
    private int id;
    private String username;
    private Date birthday;
    private String sex;
    private String address;
}

这里我使用的是Lombok 插件自动生成，使用Data注解，不需要再手写构造方法，get/set方法，和tostring方法，如不用插件可以自己填写。

1.3.1 Lombok插件

在idea中直接下载即可，然后引入Lombok jar包

1. idea中的插件：

2. 在pom.xml中引入Lombok 坐标

<dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <version>1.18.10</version>
   <scope>provided</scope>
</dependency>

1.4 编写持久层接口UserMapper

//持久层接口一般写成UserDao，或者UserMapper
public interface UserMapper {
    //查询所有用户
    List<User> findUsers();
}

1.5 编写持久层接口的映射文件UserMapper.xml

• 文件要求：
  • 创建位置必须和持久层接口在相同的包中
  • 必须以持久层接口的名称命名文件名，扩展名为.xml

<?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">
<mapper namespace="org.westos.mapper.UserMapper">
    <select id="findById" parameterType="int" resultType="User">
        select * from user where id=#{uid}
    </select>
</mapper>

1.6 编写SqlMapConfig.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>
    <!-- 引入外部配置信息 -->
    <properties resource="jdbcConfig.properties"/>
    <!-- 对实体类使用别名 -->
    <typeAliases >
        <package name="org.westos.bean"/>
    </typeAliases>
    <!-- 配置mybatis环境 -->
    <environments default="mysql">
        <!-- 配置mysql环境 -->
        <environment id="mysql">
            <!-- 配置事务的类型 -->
            <transactionManager type="JDBC"></transactionManager>
            <!-- 配置连接数据库的信息：用的是数据源（连接池） -->
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
    <!-- 告知mybatis映射配置的位置 -->
    <mappers>
        <package name="org.westos.mapper"/>
    </mappers>
</configuration>

1.7 Mysql数据库配置信息

对应核心配置中的外部配置信息

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis_test
jdbc.username=root
jdbc.password=123

1.8 编写测试类

public class Test1 {
    private InputStream inputStream;
    private SqlSession sqlSession;
    //读取核心配置文件，获取代理对象
    @Before
    public void Before() throws Throwable {
        inputStream = Resources.getResourceAsStream("SqlMapperConfig.xml");
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        sqlSession = sqlSessionFactory.openSession(true);
    }
	//释放资源
    @After
    public void After() throws Throwable {
        inputStream.close();
        sqlSession.close();
    }
	//测试代码
    @Test
    public void run0() throws Throwable {
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = mapper.findUsers();
        for (User user : users) {
            System.out.println(user);
        }
    }
}

二、基于注解的MyBatis使用

2.1 在持久层接口添加注解

public interface UserMapper {
    //查询所有用户
    @Select("select * from user")
    List<User> findUsers();
}

2.2 注意事项

• 在使用注解配置时，应移除xml的映射配置(UserMapper.xml)。

2.1 在持久层接口添加注解

public interface UserMapper {
    //查询所有用户
    @Select("select * from user")
    List<User> findUsers();
}

2.2 注意事项

• 在使用注解配置时，应移除xml的映射配置(UserMapper.xml)。