MyBatis 注解

MyBatis 注解提供了一种简单的方式来实现简单映射语句,而不会引入大量的开销。但是比较复杂的 SQL 和 动态 SQL 还是建议采用映射文件。

在这里使用 MyBatis 最基本的注解，完成常见的 CRUD（增删改查）SQL 语句映射。

环境

• JDK1.7
• MySQL 5.5.50
• mybatis 3.3.0

注：MyBatis 下载地址https://github.com/mybatis/mybatis-3/releases

需要的 jar 包

• MyBatis jar 包： mybatis-3.3.0.jar
• MySQL 驱动 jar 包： mysql-connector-java-xxx.jar
• 日志记录 jar 包： log4j-xxx.jar

项目结构

1.数据库准备

程序使用的是 MySQL 数据库。

登录 MySQL 后新建一个数据库并取名 mybatis ，创建表 user ，并插入数据：

mysql> create table user(
    -> id int primary key auto_increment,
    -> name varchar(20),
    -> sex varchar(10),
    -> age int);

insert into user(name,sex,age) values('Tom','male',20),('Jack','male',19),('Rose','female',18),('Lucy','female',19);

2.常用注解

MyBatis 的常用的注解包括：

注解	描述
@Insert @Update @Delete @Select	映射增改删查 SQL 语句
@InsertProvider @UpdateProvider @DeleteProvider @SelectProvider	映射增改删查动态 SQL 语句
@Result	在列和属性或字段之间的单独结果映射
@Results	结果映射的列表, 包含了一个特别结果列如何被映射到属性或字段的详情
@One	复杂类型的单独属性值映射，相当于 <association>
@Many	映射到复杂类型的集合属性，相当于 <collection>
@Options	提供配置选项的附加值
@Param	当映射方法需要多个参数, 这个注解可以被应用于映射器的方法 参数来给每个参数一个名字。否则,多 (不包括任何 RowBounds 参数)，如 #{param1} , #{param2} 等。 使用 @Param(“id”),参数应该被命名为 #{id}
@ResultMap	给@Select或者@SelectProvider提供在XML映射中的的id
@ResultType	当使用结果处理器时启用此注解

更多关于 Annotation 注解的介绍请参考 MyBatis 中文文档。

3.新建工程项目

（1）首先在 Eclipse 里新建一个动态 Web 工程（Dynamic Web Project），命名为 AnnotationTest 。
（2）将前面提到的三个 jar 包拷贝到工程的/WebContent/WEB-INF/lib/ 目录下，如下：

4.实体类

在Java Resources/src 的包 gler.mybatis.annotation.model 下新建类 User.java，一个用户具有 id、name、sex、age 属性。

User.java 的代码如下：

package gler.mybatis.annotation.model;

public class User {
    private Integer id;
    private String name;
    private String sex;
    private Integer age;

    public Integer getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getSex() {
        return sex;
    }

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

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

}

5.创建方法接口

新建包 gler.mybatis.annotation.mapper ，并在包下新建方法接口 UserMapper.java。

UserMapper 接口的代码如下：

package gler.mybatis.annotation.mapper;

import java.util.List;

import org.apache.ibatis.annotations.Delete;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Options;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Result;
import org.apache.ibatis.annotations.Results;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;

import gler.mybatis.annotation.model.User;

public interface UserMapper {

    /*
     * 新增用戶
     * @param user
     * @return
     * @throws Exception
     */
    @Insert("insert into user(name,sex,age) values(#{name},#{sex},#{age})")
    @Options(useGeneratedKeys=true,keyProperty="id")
    public int insertUser(User user) throws Exception;

    /*
     * 更新用戶
     * @param user
     * @throws Exception
     */
    @Update("update user set age=#{age} where id=#{id}")
    public void updateUser(User user) throws Exception;

    /*
     * 删除用戶
     * @param id
     * @return
     * @throws Exception
     */
    @Delete("delete from user where id=#{user_id}")
    public int deleteUser(@Param("user_id") Integer id) throws Exception;

    /*
     * 根据id查询用戶
     * @param id
     * @return
     * @throws Exception
     */
    @Select("select * from user where id=#{id}")
    @Results({
        @Result(id=true,property="id",column="id"),
        @Result(property="name",column="name"),
        @Result(property="sex",column="sex"),
        @Result(property="age",column="age"),
    })
    public User selectUserById(Integer id) throws Exception;

    /*
     * 查询所有用戶
     * @return
     * @throws Exception
     */
    @Select("select * from user")
    public List<User> selectAllUser() throws Exception;
}

6.配置文件 mybatis.cfg.xml

在项目目录 Java Resources/src 下新建 MyBatis 配置文件 mybatis.cfg.xml ，用来配置 Mybatis 的运行环境、数据源、事务等。

mybatis.cfg.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>    
    <!-- 配置mybatis运行环境 -->
    <environments default="development">
        <environment id="development">
           <!-- type="JDBC" 代表直接使用 JDBC 的提交和回滚设置 -->
            <transactionManager type="JDBC" />

            <!-- POOLED 表示支持JDBC数据源连接池 -->
            <!-- 数据库连接池,由 Mybatis 管理，数据库名是 mybatis，MySQL 用户名 root，密码为 root -->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver" />
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
                <property name="username" value="root" />
                <property name="password" value="root" />
            </dataSource>
        </environment>
    </environments> 
    <mappers>
        <!-- 通过 mapper 接口包加载整个包的映射文件 -->
        <package name="gler/mybatis/annotation/mapper" />
</mappers>
</configuration>

7.日志记录 log4j.properties

使用日志文件是为了查看控制台输出的 SQL 语句。

在项目目录 /Java Resources/src 下新建 MyBatis 日志记录文件
log4j.properties，在里面添加如下内容：

# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

8.测试类 Test

在包 gler.mybatis.annotations.test 下新建测试类 Test.java ，代码如下：

package gler.mybatis.annotation.test;

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

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 gler.mybatis.annotation.mapper.UserMapper;
import gler.mybatis.annotation.model.User;

public class Test {
    private static SqlSessionFactory sqlSessionFactory;

    public static void main(String[] args) {
        // Mybatis 配置文件
        String resource = "mybatis.cfg.xml";

        // 得到配置文件流
        InputStream inputStream = null;
        try {
            inputStream = Resources.getResourceAsStream(resource);
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 创建会话工厂，传入 MyBatis 的配置文件信息
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        insertUser();
        // updateUser();
        // deleteUser();
        // selectUserById();
        // selectAllUser();

    }

    // 新增用户
    private static void insertUser(){
        // 通过工厂得到 SqlSession
        SqlSession session = sqlSessionFactory.openSession();

        UserMapper mapper = session.getMapper(UserMapper.class);
        User user = new User();
        user.setName("Anne");
        user.setSex("female");
        user.setAge(23);
        try {
            mapper.insertUser(user);

            session.commit();
        } catch (Exception e) {
            e.printStackTrace();
            session.rollback();
        }

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

    // 将id为1的用户的年龄更新为25
    private static void updateUser(){
        SqlSession session = sqlSessionFactory.openSession();

        UserMapper mapper = session.getMapper(UserMapper.class);
        User user = null;
        try {
            user = mapper.selectUserById(1);
        } catch (Exception e1) {
            e1.printStackTrace();
        }
        user.setAge(25);
        try {
            mapper.updateUser(user);
            session.commit();
        } catch (Exception e) {
            e.printStackTrace();
            session.rollback();
        }

        session.close();
    }

    // 将id为5的用户删除
    private static void deleteUser(){
        SqlSession session = sqlSessionFactory.openSession();

        UserMapper mapper = session.getMapper(UserMapper.class);
        try {
            mapper.deleteUser(5);
            session.commit();
        } catch (Exception e) {
            e.printStackTrace();
            session.rollback();
        }

        session.close();
    }

    // 查询id为1的用户信息
    private static void selectUserById(){
        SqlSession session = sqlSessionFactory.openSession();

        UserMapper mapper = session.getMapper(UserMapper.class);
        try {
            User user = mapper.selectUserById(1);
            session.commit();
            System.out.println(user.getId() + " " + user.getName()  + " " + user.getSex() + " "
                    + user.getAge());
        } catch (Exception e) {
            e.printStackTrace();
            session.rollback();
        }

        session.close();
    }

    // 查询所有用户信息
    private static void selectAllUser(){
        SqlSession session = sqlSessionFactory.openSession();

        UserMapper mapper = session.getMapper(UserMapper.class);
        try {
            List<User> userList = mapper.selectAllUser();
            session.commit();
            for (User user : userList) {
                System.out.println(user.getId() + " " + user.getName()  + " " + user.getSex() + " "
                        + user.getAge());
            }
        } catch (Exception e) {
            e.printStackTrace();
            session.rollback();
        }

        session.close();
    }
}

9.运行测试

分别调用 Test 类中的增删改查方法

结果如下：

（1）insertUser()

插入一条用户数据：

1>控制台输出

2>查看数据库

（2）updateUser()

将 id 为1的用户的 age 修改为 25：

1>控制台输出

2>查看数据库

（3）deleteUser()

将 id 为5的用户删除：

1>控制台输出

2>查看数据库

（4）selectUserById()

查询 id 为1的用户信息：

（5）selectAllUser()

查询所有用户信息：

参考链接

• MyBatis学习笔记(四) 注解
• 《Spring+MyBatis 企业应用实战》