Dao层 - MyBatis框架 - 入门程序+连接数据库配置文件的多样式

原创于 2025-11-23 11:17:27 发布 · 364 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis #java #servlet #idea #数据库

java基础专栏收录该内容

41 篇文章

订阅专栏

3. 使用元素读取外部jdbc.properties属性文件和${}占位符来引用属性

一、MyBatis框架概述

MyBatis是一个优秀的基于Java的持久层框架，内部对JDBC做了封装，使开发者只需要关注SQL语句，而不是关注JDBC的代码，使开发变得更加简单。
MyBatis通过XML或注解，将要执行的各种Statement对象（代表了要执行的SQL语句）配置起来，通过Java对象和Statement中SQL的动态参数进行映射，并最终执行SQL语句。执行SQL后，最终将结果益Java对象返回。
采用了ORM思想。

二、入门程序

1. 创建数据库和表结构

create database mybatis_db;
use mybatis_db;

CREATE TABLE `user` (
  `id` int(11) NOT NULL auto_increment,
  `username` varchar(32) NOT NULL COMMENT '用户名称',
  `birthday` datetime default NULL COMMENT '生日',
  `sex` char(1) default NULL COMMENT '性别',
  `address` varchar(256) default NULL COMMENT '地址',
  PRIMARY KEY  (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

insert  into `user`(`id`,`username`,`birthday`,`sex`,`address`) values 
(1,'老王','2018-02-27 17:47:08','男','北京'),
(2,'熊大','2018-03-02 15:09:37','女','上海'),
(3,'熊二','2018-03-04 11:34:34','女','深圳'),
(4,'光头强','2018-03-04 12:04:06','男','广州');

2. 创建maven的Java项目，引入坐标依赖：mybatis核心包、MySQL驱动包、Junit单元测试包、log4j日志包

    <!--控制编码,maven版本-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <!--单元测试依赖-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.1</version>
            <scope>test</scope>
        </dependency>
        <!--mybatis核心包-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>
        <!--mysql驱动包-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.6</version>
        </dependency>
        <!--日志-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>

3. 编写实体类，属性使用包装类：

package com.tx.entity;

import java.io.Serializable;
import java.util.Date;

// 实体类
public class User implements Serializable {
    // 字段 - 与mysql中的字段要一致
    private Integer id;
    private String username;
    private Date birthday;
    private String sex;
    private String address;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", birthday=" + birthday +
                ", sex='" + sex + '\'' +
                ", address='" + address + '\'' +
                '}';
    }
}

4. 编写UserMapper接口和方法（就是以前的UserDao接口）

package com.tx.mapper;

import com.tx.entity.User;

import java.util.List;

// 接口类
// 实现类：是UserMapper.xml文件
public interface UserMapper {
    /**
     * 查询所有的用户
     */
    public List<User> findAll();
}

5. 再resources目录下，创建mapper文件夹。编写UserMapper.xml的配置文件，导入约束

namespace：名称空间，表明以后查找UserMapper接口中的findAll的方法。
id属性：编写的UserMapper接口中的方法的名称，固定的。
resultType属性：表明的是findAll方法的返回值类型。

<?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">
<!--namespace：名称空间-->
<mapper namespace="com.tx.mapper.UserMapper">
    <select id="findAll" resultType="com.tx.entity.User">
        select * from user;
    </select>
</mapper>

6. 编写主配置文件，再resources目录下传教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>
    <!--主配置文件-->
    <!--配置环境们-->
    <environments default="mysql">
        <!--配置环境-->
        <environment id="mysql">
            <!--配置事务的类型，使用本地事务策略-->
            <transactionManager type="JDBC"></transactionManager>
            <!--配置是否使用连接池 POOLED表示使用链接池，UNPOOLED表示不使用连接池-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql:///mybatis_db"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>

    <!--加载映射文件-->
    <mappers>
        <mapper resource="mapper/UserMapper.xml"></mapper>
    </mappers>
</configuration>

7. 编写入门程序（重点掌握）

package com.tx.test;

import com.tx.entity.User;
import com.tx.mapper.UserMapper;
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 org.junit.Test;

import java.io.InputStream;
import java.util.List;

public class UserTest {
    /**
     * 查询所有方法
     * @throws Exception
     */
    @Test
    public void testFindAll() throws Exception {
        // 1. 加载主配置文件，目的是构建SqlSessionFactory对象
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
        // 2. 创建SqlSessionFactory(Sql会话工厂)对象
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
        // 3. 获取session对象，使用SqlSessionFactory工厂对象创建SqlSession对象
        SqlSession session = factory.openSession();

        /**
         * 方法一：基于Mapper接口
         * 通过会话创建代理对象，执行代理对象中的方法
         */
        // 4. 通过session创建UserMapper接口的代理对象
        UserMapper mapper = session.getMapper(UserMapper.class);
        // 5. 执行方法
        List<User> list = mapper.findAll();
        for (User user:list){
            System.out.println(user);
        }

        /**
         * 方法二：基于 statement ID 的方式（不推荐使用）
         * 由命名空间+方法名称组成
         */
        /*List<User> list = session.selectList("com.tx.mapper.UserMapper.findAll");
        for (User user:list){
            System.out.println(user);
        }*/

        // 6. 释放资源
        session.close();
        in.close();
    }
}

三、连接数据库配置文件的多样式

在SqlMapConfig.xml配置文件中连接数据库有三种形式：

在配置环境中直接配置数据源属性
在配置环境中使用<properties>元素和${}占位符来引用属性
在配置环境中使用<properties>元素读取外部jdbc.properties属性文件和${}占位符来引用属性

1. 直接配置数据源属性

<?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>
    <!--主配置文件-->
    <!--配置环境们-->
    <environments default="mysql">
        <!--配置环境-->
        <environment id="mysql">
            <!--配置事务的类型，使用本地事务策略-->
            <transactionManager type="JDBC"></transactionManager>
            <!--配置是否使用连接池 POOLED表示使用链接池，UNPOOLED表示不使用连接池-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql:///mybatis_db"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>

    <!--加载映射文件-->
    <mappers>
        <mapper resource="mapper/UserMapper.xml"></mapper>
    </mappers>
</configuration>

2. 使用<properties>元素和${}占位符来引用属性

<?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>
        <property name="jdbc.driver" value="com.mysql.jdbc.Driver"/>
        <property name="jdbc.url" value="jdbc:mysql:///mybatis_db"/>
        <property name="jdbc.username" value="root"/>
        <property name="jdbc.password" value="root"/>
    </properties>

    <!--主配置文件-->
    <!--配置环境们-->
    <environments default="mysql">
        <!--配置环境-->
        <environment id="mysql">
            <!--配置事务的类型，使用本地事务策略-->
            <transactionManager type="JDBC"></transactionManager>
            <!--配置是否使用连接池 POOLED表示使用链接池，UNPOOLED表示不使用连接池-->
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.userneme}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

    <!--加载映射文件-->
    <mappers>
        <mapper resource="mapper/UserMapper.xml"></mapper>
    </mappers>
</configuration>

3. 使用<properties>元素读取外部jdbc.properties属性文件和${}占位符来引用属性

1. 定义jdbc.properties属性文件

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql:///mybatis_db
jdbc.username=root
jdbc.password=root

2. 编写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>
    <!--读取外部jdbc.properties属性文件-->
    <properties resource="jdbc.properties"></properties>
    <!--配置环境们-->
    <environments default="mysql">
        <!--配置环境-->
        <environment id="mysql">
            <!--配置事务的类型，使用本地事务策略-->
            <transactionManager type="JDBC"></transactionManager>
            <!--配置是否使用连接池 POOLED表示使用链接池，UNPOOLED表示不使用连接池-->
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.userneme}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

    <!--加载映射文件-->
    <mappers>
        <mapper resource="mapper/UserMapper.xml"></mapper>
    </mappers>
</configuration>