MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code,并且改名为MyBatis 。2013年11月迁移到Github。iBATIS一词来源于“internet”和“abatis”的组合,是一个基于Java的持久层框架。
MyBatis是支持普通SQL查询,存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装。MyBatis可以使用简单的XML或注解用于配置和原始映射,将接口和Java的POJO(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录。
首先需要加入需要的jar包,构建Spring环境请参考:Spring学习之第一个hello world程序。这里我们需要加入mybatis包和MySQL驱动包,使用IDEA环境来开发程序,最后工程加入的包如下图所示:
然后需要在test数据库中新建测试表user,sql语句如下所示:
create table users ( id int primary key auto_increment, name varchar(20), age int ); insert into users (name, age) values('Tom', 12); insert into users (name, age) values('Jack', 11);
1.1 定义表对应的实体类
public class User { private int id; private String name; private int age; public User() { } public User(int id, String name, int age) { this.id = id; this.name = name; this.age = age; } public int getId() { return id; } public void setId(int id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } @Override public String toString() { return "User{" + "id=" + id + ", name='" + name + '\'' + ", age=" + age + '}'; } }
1.2 定义MyBatista的mybatisConfig.xml配置文件和user表的sql映射文件userMapper.xml
mybatisConfig.xml文件,该文件是在src目录下新建的。
<?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="development"> <!-- development:开发环境 work:工作模式 --> <environment id="development"> <transactionManager type="JDBC" /> <!-- 数据库连接方式 --> <dataSource type="POOLED"> <property name="driver" value="com.mysql.jdbc.Driver" /> <property name="url" value="jdbc:mysql://192.168.1.150/test" /> <property name="username" value="root" /> <property name="password" value="123456" /> </dataSource> </environment> </environments> <!-- 注册表映射文件 --> <mappers> <mapper resource="com/mybatis/userMapper.xml"/> </mappers> </configuration>
userMapper.xml文件,该配置文件在com.mybatis包下,user表对应的实体类User也在com.mybatis包下。
<?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="com.mybatis.userMapper"> <!-- 根据id查询一个User对象 --> <select id="getUser" parameterType="int" resultType="com.mybatis.User"> select * from users where id=#{id} </select> <select id="getUserAll" resultType="com.mybatis.User"> select * from users </select> <!-- 插入一个User对象 --> <insert id="insertUser" parameterType="com.mybatis.User"> insert into users (name, age) value(#{name}, #{age}) </insert> <!-- 删除一个User对象 --> <delete id="deleteUser" parameterType="int"> delete from users where id=#{id} </delete> <!-- 更新一个User对象--> <update id="updateUser" parameterType="com.mybatis.User"> update users set name=#{name}, age=#{age} where id=#{id} </update> </mapper>
测试代码如下:
public class mybaitstest { SqlSessionFactory sessionFactory = null; SqlSession sqlSession = null; { String resource = "mybatisConfig.xml"; // 加载mybatis的配置文件(它也加载关联的映射文件) Reader reader = null; try { reader = Resources.getResourceAsReader(resource); } catch (IOException e) { e.printStackTrace(); } // 构建sqlSession的工厂 sessionFactory = new SqlSessionFactoryBuilder().build(reader); // 创建能执行映射文件中sql的sqlSession,默认是手动提交事务的,使用自动提交的话加上参数 true sqlSession = sessionFactory.openSession(true); } public void testSelectUser() { // 映射sql的标识字符串 String statement = "com.mybatis.userMapper" + ".getUser"; // 执行查询返回一个唯一user对象的sql User user = sqlSession.selectOne(statement, 1); System.out.println(user); } public void testSelectAll() { List<User> users = sqlSession.selectList("com.mybatis.userMapper.getUserAll"); System.out.println(users); } public void testInsertUser(User user) { int insert = sqlSession.insert("com.mybatis.userMapper.insertUser", user); // 如果不是自动提交的话,需要使用 sqlSession。commit() System.out.println(insert); } public void testDeleteUser(int id) { int delete = sqlSession.delete("com.mybatis.userMapper.deleteUser", id); System.out.println(delete); } public void testUpdateUser(User user) { int update = sqlSession.update("com.mybatis.userMapper.updateUser", user); System.out.println(update); } public static void main(String[] args) throws IOException { new mybaitstest().testSelectUser(); } }
最后输出结果为:
2 基于注解的方式使用MyBatis
基于注解的方式使用MyBatis,首先定义对应表的sql映射接口。
public interface IUserMapper { @Insert("insert into users (name, age) value(#{name}, #{age})") public int add(User user); @Delete("delete from users where id=#{id}") public int deleteById(int id); @Update("update users set name=#{name}, age=#{age} where id=#{id}") public int update(User user); @Select("select * from users where id=#{id}") public User getById(int id); @Select("select * from users") public List<User> getAll(); }
然后在mybatisConfig.xml配置文件中注册该接口:
<!-- 注册表映射文件 -->
<mappers>
<mapper class="com.mybatis.IUserMapper"/>
</mappers>
测试示例:
/** * 使用注解测试的方法 */ public void test() { IUserMapper userMapper = sqlSession.getMapper(IUserMapper.class); User user = userMapper.getById(1); System.out.println(user); }
3 如何简化配置操作
以上两个程序示例都是直接在配置文件中写连接数据库的信息,其实还可以专门把数据库连接信息写到一个db.proteries文件中,然后由配置文件来读取该db.properies文件信息。db.proteries文件内容如下:
user=root
password=123456
driverClass=com.mysql.jdbc.Driver
jdbcUrl=jdbc:mysql://192.168.1.150/test
然后在mybatisConfig.xml配置文件中将数据库环境信息更改为如下所示:
<properties resource="db.properties"/> <environments default="development"> <!-- development:开发环境 work:工作模式 --> <environment id="development"> <transactionManager type="JDBC" /> <!-- 数据库连接方式 --> <dataSource type="POOLED"> <property name="driver" value="${driverClass}" /> <property name="url" value="${jdbcUrl}" /> <property name="username" value="${user}" /> <property name="password" value="${password}" /> </dataSource> </environment> </environments>
配置表对应的sql映射文件时,可以使用别名来简化配置,在mybatisConfig.xml中添加如下配置,在userMapper中parameterType就可以配置为"_User"。
<typeAliases> <typeAlias type="com.mybatis.User" alias="_User"/> </typeAliases>
4 字段名与实体类属性名不匹配的冲突
新建表和数据,在test数据库中执行以下SQL语句:
create table orders ( order_id int primary key auto_increment, order_no varchar(20), order_price float ); insert into orders (order_no, order_price) values('aaa', 12); insert into orders (order_no, order_price) values('bbb', 13); insert into orders (order_no, order_price) values('ccc', 14);
创建对应表的类:
public class Order { private int i; private String no; private float price; public Order() { } public Order(int i, String no, float price) { this.i = i; this.no = no; this.price = price; } public int getI() { return i; } public void setI(int i) { this.i = i; } public String getNo() { return no; } public void setNo(String no) { this.no = no; } public float getPrice() { return price; } public void setPrice(float price) { this.price = price; } }