java进阶|MyBatis系列文章(一)基础性文章的思考增删改查

最新推荐文章于 2023-01-04 21:33:35 发布

码农王同学

最新推荐文章于 2023-01-04 21:33:35 发布

阅读量136

点赞数

本文链接：https://blog.csdn.net/qq_35006660/article/details/105592370

版权

本文介绍了MyBatis框架的基础概念，并通过实例展示了如何使用Statement的原生方式和XML方式操作数据库。强调了XML方式在动态SQL方面的优势。内容包括：jar包依赖、数据库配置、User类定义、UserMapper接口和XML映射文件的编写，以及基于单元测试的CRUD操作。文章旨在帮助读者快速理解MyBatis的会话工厂和会话接口的使用。

摘要由CSDN通过智能技术生成

MyBatis框架概念介绍

MyBatis是支持定制化SQL,存储过程以及高级映射的优秀的持久层框架。MyBatis避免了几乎所有的JDBC代码和手动参数以及获取结果集。
MyBatis可以对配置和原生Map使用简单的XML或注解，将接口和Java的POJOS(Plain Old Java Objects，普通的Java对象)映射成数据库中的记录。

本篇文章主要是使用statetment最原生的方式操作数据库以及基于xml方式操作数据库，为什么自己又去写xml方式操作数据了呢，写了几篇示例程序觉得还是xml方式在支持动态sql方面有着强大的能力，嗯，后面自己会慢慢在用xml方式进行mybatis的操作吧。

一，这篇文章涉及到的jar包依赖信息如下

      <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.2</version>
        </dependency>


        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

记得在单元测试用例里面测试代码时，要在pom文件里面配置一下

   <!--在单元测试里面执行时记得加上下面的这部分配置信息，自己将xml文件放到src下面了-->
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>

二：这个项目使用的最原生的方式配置的连接数据库的信息。 Configuration.xml文件放入到resouces文件下即classpath下。

<?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">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <!-- 配置数据库连接信息 -->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/learn?serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/wpw/mybatislearn/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

三，基础类的定义，也是整个全局我们操作的user

package com.wpw.mybatislearn.entity;


import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;


import java.io.Serializable;


/**
 * @author 用户基础类
 */
@AllArgsConstructor
@NoArgsConstructor
@Data
@Builder
@Accessors(chain = true)
public class User implements Serializable {
    private Integer id;
    private String userName;
    private Integer age;
}

四，和数据库进行交互的UserMapper接口涉及的代码编写。

package com.wpw.mybatislearn.mapper;


import com.wpw.mybatislearn.entity.User;


import java.util.List;


/**
 * userMapper类，和db进行交互
 *
 * @author wpw
 */
public interface UserMapper {
    /**
     * 根据用户id查询用户信息
     *
     * @param id 用户id
     * @return 用户user信息
     */
    User searchUser(Integer id);


    /**
     * 获取用户列表
     *
     * @return userList
     */
    List<User> listUser();


    /**
     * 保存用户信息
     *
     * @param user 用户信息
     * @return 是否插入成功
     */
    Integer insert(User user);


    /**
     * 更新用户信息
     *
     * @param user 用户信息
     * @return 是否更新成功
     */
    Integer update(User user);


    /**
     * 根据用户id删除用户信息
     *
     * @param id 用户id
     * @return 是否删除成功
     */
    Integer delete(Integer id);
}

以上就是基本的单表的CRUD操作，具体的实现是在test测试用例里面进行操作的。

五，基于代理的方式UserMapper接口需要编写对应的UserMapper.xml进行编写对应的Sql。

<?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，namespace的值习惯上设置成包名+sql映射文件名，这样就能够保证namespace的值是唯一的
 -->
<mapper namespace="com.wpw.mybatislearn.mapper.UserMapper">
    <resultMap id="userResultMap" type="com.wpw.mybatislearn.entity.User">
        <id property="id" column="id"/>
        <result property="userName" column="user_name"/>
        <result property="age" column="age"></result>
    </resultMap>
    <select id="searchUser" parameterType="int" resultMap="userResultMap">
        select *
        from user
        where id = #{id};
    </select>
    <select id="listUser" resultMap="userResultMap">
        select *
        from user;
    </select>
    <insert id="insert" parameterType="com.wpw.mybatislearn.entity.User" useGeneratedKeys="true" keyProperty="id"
            flushCache="true">
        insert into user(user_name, age)
        values (#{userName}, #{age})
    </insert>
    <update id="update" parameterType="com.wpw.mybatislearn.entity.User">
        update user
        set user_name=#{userName},
            age=#{age}
        where id = #{id}
    </update>
    <delete id="delete" parameterType="int" flushCache="true">
        delete
        from user
        where id = #{id}
    </delete>
</mapper>

上面的配置信息就完成了，然后最后我这里是基于单元测试用例进行编写的，但是代码是存在冗余的，这里没有进行提取，望见谅，其主要目的就是快速帮助我们理解这里面的交互逻辑。

package com.wpw.mybatislearn;


import com.wpw.mybatislearn.entity.User;
import com.wpw.mybatislearn.mapper.UserMapper;
import jdk.nashorn.internal.ir.annotations.Ignore;
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.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;


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


@SpringBootTest
class MybatisLearnApplicationTests {
    private static final ThreadLocal<SqlSession> threadLocal = new ThreadLocal<>();


    @Test
    void contextLoads() {
    }


    private static SqlSessionFactory sqlSessionFactory = null;
    private static InputStream inputStream = null;


    static {
        try {
            //加载mybatis连接数据库的配置信息，获取文件流
            inputStream = Resources.getResourceAsStream("Configuration.xml");
            //获取会话工厂信息
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }


    /**
     * 获取会话工厂
     *
     * @return 会话工厂
     */
    public SqlSessionFactory getSqlSessionFactory() {
        return sqlSessionFactory;
    }


    @Test
    @Ignore
    public void searchUser() {
        //获取数据库会话sqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            //获取代理类UserMapper
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            User user = userMapper.searchUser(1);
            //输出获取的信息
            System.out.println("user = " + user);
        } finally {
            //释放当前会话连接
            sqlSession.close();
        }
    }


    @Test
    @Ignore
    public void listUser() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            List<User> userList = userMapper.listUser();
            userList.stream().filter(Objects::nonNull).forEachOrdered(x -> {
                System.out.println(String.format("用户id:%d,用户名称:%s,年纪:%d", x.getId(), x.getUserName(), x.getAge()));
            });
            System.out.println("查询出的数据量为" + userList.size());
        } finally {
            //释放当前会话的连接
            sqlSession.close();
        }
    }


    @Test
    @Ignore
    public void insert() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            Integer insert = userMapper.insert(User.builder().build().setUserName("admin").setAge(10));
            System.out.println("insert = " + insert);
            //默认不开启事务自动提交,可以在openSession()设置自动提交
            sqlSession.commit();
        } finally {
            //释放连接
            sqlSession.close();
        }
    }


    @Test
    @Ignore
    public void update() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            Integer update = userMapper.update(User.builder().build().setId(12).setUserName("admin-info2").setAge(12));
            System.out.println("update = " + update);
            //手动提交事务
            sqlSession.commit();
        } finally {
            //释放连接
            sqlSession.close();
        }
    }


    @Test
    @Ignore
    public void delete() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            Integer delete = userMapper.delete(13);
            System.out.println("delete = " + delete);
            sqlSession.commit();
        } finally {
            //释放连接
            sqlSession.close();
        }
    }


    final String statementPrefix = "com.wpw.mybatislearn.mapper.UserMapper";


    @Test
    @Ignore
    public void searchByNamespace() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            final String statement = statementPrefix + ".searchUser";
            User user = sqlSession.selectOne(statement, 1);
            System.out.println("user = " + user);
        } finally {
            //释放连接
            sqlSession.close();
        }
    }


    @Test
    @Ignore
    public void searchByNamespaceAndName() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            List<User> userList = sqlSession.selectList(statementPrefix + ".listUser");
            userList.stream().filter(Objects::nonNull).forEach(x -> {
                System.out.println(String.format("id:%d,userName:%s,age:%d", x.getId(), x.getUserName(), x.getAge()));
            });
        } finally {
            //释放连接
            sqlSession.close();
        }
    }


    @Test
    @Ignore
    public void insertByNamespace() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            sqlSession.insert(statementPrefix + ".insert", User.builder().build().setUserName("statement").setAge(10));
            //手动提交事务
            sqlSession.commit();
        } finally {
            //释放连接
            sqlSession.close();
        }
    }


    @Test
    @Ignore
    public void updateByNamespace() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            int update = sqlSession.update(statementPrefix + ".update", User.builder().build()
                    .setId(14).setUserName("statement-update").setAge(10));
            System.out.println("update = " + update);
            sqlSession.commit();
        } finally {
            //释放连接
            sqlSession.close();
        }
    }


    @Test
    public void deleteByNamespace() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            int delete = sqlSession.delete(statementPrefix + ".delete", 14);
            System.out.println("delete = " + delete);
            sqlSession.commit();
        } finally {
            //释放连接
            sqlSession.close();
        }
    }
}

上面的所有单元测试用例使用了两种方式编写，一种是基于代理的方式使用UserMapper接口和UserMapper.xml进行一一对应进行增删改查的操作，另外一个就是基于sqlSession进行原生的操作db来完成对数据库的操作，这是最原生的方式，和jdbcTemplate差不多，下面看下sqlSession接口提供的方法都有哪些。

以上整个操作的流程中了解如何创建一个会话工厂，如何根据会话工厂创建会话连接，基于sqlSession的两种方式进行操作数据库的操作就算完全掌握了这篇文章要分享的目的。

代码地址:https://github.com/myownmyway/myybatis-learn.git

需要的可以直接进行下载，这个代码是public权限的，也就是说是可以随意下载的。

补充一点涉及的sql文件信息:

create database learn;
use learn;
select database();
show tables;
create table if not exists user
(
    id        int auto_increment primary key not null comment '用户id',
    user_name varchar(255)                   not null comment '用户名称',
    age       int(3)                         not null comment '用户年纪'
);
show index from user;
explain select * from user;
insert into user(user_name,age) values("admin",1);
insert into user(user_name,age) values("admin",2);
insert into user(user_name,age) values("admin",3);
insert into user(user_name,age) values("admin",4);
insert into user(user_name,age) values("admin",5);
insert into user(user_name,age) values("admin",6);
insert into user(user_name,age) values("admin",7);
insert into user(user_name,age) values("admin",8);
insert into user(user_name,age) values("admin",9);
insert into user(user_name,age) values("admin",10);
insert into user(user_name,age) values("admin",11);