MyBatis 快速入门

一 MyBatis简介

MyBaties是一款优秀的持久层框架,他支持定制化sql,存储过程以及高级映射,Mybatis避免了几乎所有的JDBC代码和手动设置参数以及获取结果集.Mybatis可以使用简单的XML或注解来配置和原生类型,接口和java的POJO(Plain odl java object) 为数据库中的记录MyBatis本事apache的一个开源项目iBaties,2010年这个项目由apache software foudation 迁移到了google code 并改名为mybaties,2013年11月其迁移到GitHub

在传统的jdbc中我们除了自己定义sql外,还需要创建数据库连接池,获取数据库连接,创建命令对象,处理结果集等等,jdbc的使用是极其枯燥和繁琐的

而当我们使用了mybatis之后,我们只需要关注sql语句,几乎所有的 JDBC 代码以及设置参数和获取结果集的工作都交给mybatis去处理

二 搭建mybatis环境及测试

1.导入mybatis相关的jar包

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.2</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
</dependency>

2,创建数据库便于练习

CREATE DATABASE `mybatis`;
 
USE `mybatis`;
 
DROP TABLE IF EXISTS `user`;
 
CREATE TABLE `user` (
  `id` int(20) NOT NULL,
  `name` varchar(30) DEFAULT NULL,
  `pwd` varchar(30) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 
insert  into `user`(`id`,`name`,`pwd`) values (1,'doer','123456'),(2,'狗熊','4789798'),(3,'李四','123456');

3,创建数据库对应实体类

• 图个方便使用lombok插件自动配置get set 以及有参 无参构造方法
• 创建实体类的时候,属性名最好和数据库字段保持一致,不一致会导致null值,需要通过resultMap进行映射处理

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private int id;
    private String name;
    private String pwd;
}

4,编写UserMapper接口类

public interface UserMapper {
    //查询所有用户
    List<User> queryUser();

}

5,编写MyBatis核心配置文件

• environments 标签中可以配置数据源信息,等
• typeAliases 标签是类型别名,便于后面写sql更加方便,
• mapper 映射器, 我们将sql写好之后,我们需要告诉mybatis去哪里找到这些语句在自动查找资源方面，Java 并没有提供一个很好的解决方案，所以最好的办法是直接告诉 MyBatis 到哪里去找映射文件 每一个mapper对应的是数据库中的一张表,对于该表的所有增删改查处理都在mapper 配置的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>
    
    <typeAliases>
        <package name="com.doer.pojo"/>
    </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/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF8"/>
                <property name="username" value="root"/>
                <property name="password" value="tong0726"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="com/doer/dao/UserMapper.xml"/>
    </mappers>
</configuration>

6 ,编写UserMapper.xml配置文件

• Mapper.xml对应的就是我们上面写的UserMapper类 ,在xml中我们进行数据的CRUD操作,需要注意的是,配置文件需要和接口名保持一致,
• namespace 十分重要,对应的是接口的路径,

<?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.doer.dao.UserMapper">
    <select id="queryUser" resultType="User">
        select * from mybatis.user
    </select>
</mapper>

7 ,编写一个工具类

public class MybatisUtil {
    private static SqlSessionFactory sqlSessionFactory;

    static {
        String resource = "mybatis-config.xml";
        try {
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();

    }

}

8 测试

@Test
public void queryUser(){
    SqlSession sqlSession = MybatisUtil.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    List<User> userList = mapper.queryUser();
    for (User user : userList) {
        System.out.println(user);
    }
}

输出

三,mybatis 实现CURD

3.1 select

选择查询语句

• id： 就是对应的namespace中的方法名
• resultType： sql语句执行的返回结果
• parameterType : 参数类型

1.编写接口

public interface UserMapper {
    //查询全部用户
    List<User> getUserList();

    //根据id查询用户
    User getUserById(int id);

    //增加一个用户
    int addUser(User user);

    //修改用户
    int updateUser(User id);

    //删除一个用户
    int deleteUser(int id);
}

2,编写对应mapper中的sql语句

<!--select查询语句-->
<select id="getUserList" resultType="com.doer.pojo.User"   >
    select * from mybatis.user
</select>
<select id="getUserById" parameterType="int" resultType="com.doer.pojo.User">
    select * from mybatis.user where id = #{id}
</select>

3,测试<增删改需要提交事务>

@Test
    public void test(){
        //第一步获得SqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();

        //执行sql 方式一：getMapper
        UserMapper userDao = sqlSession.getMapper(UserMapper.class);
        List<User> userList = userDao.getUserList();
        for (User user : userList) {
            System.out.println(user);
        }
        sqlSession.close();
    }

3.2 Insert

<insert id="addUser" parameterType="com.doer.pojo.User" >
    insert into mybatis.user(id,name,pwd) values (#{id},#{name },#{pwd});
</insert>

3.3 update

<update id="updateUser" parameterType="com.doer.pojo.User">
    update mybatis.user set name=#{name},pwd=#{pwd}  where id=#{id};
</update>

3.4 delete

<delete id="deleteUser" parameterType="int">
    delete from mybatis.user where id = #{id};
</delete>

四,使用注解实现CRUD

使用注解和在xml中配置是一样的需要在接口使用@XXXX注解的

1.在接口上使用注解

public interface UserMapper {
    @Select("select * from user")
    List<User> getUser();
}

2.在核心配置文件中绑定接口

<mappers>
    <mapper class="com.doer.dao.UserMapper"/>
</mappers>

3测试

@Test
public void getUser(){
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    List<User> user = mapper.getUser();
    for (User user1 : user) {

        System.out.println(user1);
    }
    sqlSession.close();
}

CRUD

@Select("select * from user")
List<User> getUser();

@Select("select * from user where id = #{id}")
User getUserById(@Param("id") int id);

@Insert("insert into user(id,name,pwd) values(#{id},#{name},#{pwd})")
int addUser(User user);

@Delete("delete from user where id = #{id}")
int deleteUser(@Param("id") int id);

@Update("update user set name = #{name},pwd=#{pwd} where id=#{id}")
int updateUser(User user);

@parm注解

如果不使用 @Param，就应该定义与 mapper接口方法相同的参数,如果使用 @Param，就可以只定义需要使用的参数

关于Mybatis @Param 注解，官方文档:链接

• 基本类型的参数或者String 类型需要加上该注解
• 自定义类型注解不需要加
• 如果只有一个基本类型的话,可以忽略,但是建议都加上
• 如果使用Parm注解,那么在sql中引用的就是该注解参数中设定的属性名