Mybatis学习记录---基本增删改查方法

朱雀 2022-04-11 02:24 215阅读 0赞

在看了部分跟mybatis相关的书籍以后，重新更新下mybatis入门的相关代码。

mybatis的官网文档：[http://www.mybatis.org/mybatis-3/zh/getting-started.html][http_www.mybatis.org_mybatis-3_zh_getting-started.html]。这个文档是官方中文版的，对mybatis有很详细的介绍，推荐入门学习。

![Mybatis框架][Mybatis] Mybatis框架

--------------------

**目录**

1、创建数据库

2、创建maven项目

3、导入需要的依赖包

4、创建Mybatis配置文件conf.xml

5、创建实体类

6、创建UserMapper.java

7、添加users表sql的映射文件userMapper.xml

8、在conf.xml注册userMapper.xml

9、创建SqlSessionFactory工具类

10、代码测试

--------------------

# #

## 1、创建数据库 ##

创建数据库和表。

CREATE DATABASE mybatis-study;
    USE mybatis-study;
    CREATE TABLE `m_user` (
      `id` bigint(11) NOT NULL AUTO_INCREMENT,
      `account` varchar(32) DEFAULT NULL,
      `password` varchar(255) DEFAULT NULL,
      `create_time` datetime DEFAULT NULL,
      `update_time` datetime DEFAULT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=12 DEFAULT CHARSET=utf8;

### 2、创建maven项目 ###

具体流程查看[IDEA创建基本maven项目][IDEA_maven]。

为了之后理解项目结构，提前把最终的目录贴出来

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW56ejI1NjA_size_16_color_FFFFFF_t_70][]

### 3、导入需要的依赖包 ###

在pom.xml导入mybatis和mysql的依赖包，这样就不需要自己导入包。

<?xml version="1.0" encoding="UTF-8"?>
    
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>czz.study</groupId>
        <artifactId>mybatis</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <name>mybatis</name>
        
        <url>http://www.example.com</url>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <maven.compiler.source>1.7</maven.compiler.source>
            <maven.compiler.target>1.7</maven.compiler.target>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
    
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.4.2</version>
            </dependency>
    
            
            <dependency>
              <groupId>org.mybatis</groupId>
              <artifactId>mybatis-typehandlers-jsr310</artifactId>
              <version>1.0.1</version>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.46</version>
            </dependency>
    
            
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.11</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <pluginManagement>
                <plugins>
                    <plugin>
                        <artifactId>maven-clean-plugin</artifactId>
                        <version>3.0.0</version>
                    </plugin>
                    
                    <plugin>
                        <artifactId>maven-resources-plugin</artifactId>
                        <version>3.0.2</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-compiler-plugin</artifactId>
                        <version>3.7.0</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-surefire-plugin</artifactId>
                        <version>2.20.1</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-jar-plugin</artifactId>
                        <version>3.0.2</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-install-plugin</artifactId>
                        <version>2.5.2</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-deploy-plugin</artifactId>
                        <version>2.8.2</version>
                    </plugin>
                </plugins>
            </pluginManagement>
        </build>
    </project>

### 4、创建Mybatis配置文件conf.xml ###

XML 配置文件（configuration XML）中包含了对 MyBatis 系统的核心设置，包含获取数据库连接实例的数据源（DataSource）和决定事务作用域和控制方式的事务管理器（TransactionManager）。在src下创建一个conf.xml文件，如下图所示。这里目前只添加了数据源相关的配置（Mysql）。

### 5、创建实体类 ###

创建表对应实体类，并添加set/get/toString相关方法：

package czz.domain;
    
    import java.io.Serializable;
    import java.time.LocalDateTime;
    import lombok.Data;
    
    /**
     * 账户信息实体类
     *
     * @author chenzhengzhou
     * @version 1.0
     * @date 2019/3/25 9:19
     */
    @Data
    public class User  {
    
        /**
         * 主键id
         */
        private Long id;
    
        /**
         * 登录账号
         */
        private String account;
    
        /**
         * 登录密码
         */
        private String password;
    
        /**
         * 创建时间
         */
        private LocalDateTime createTime;
    
        /**
         * 更新时间
         */
        private LocalDateTime updateTime;
    }

### 6、创建UserMapper.java ###

在mapper包内创建UserMapper.java，并添加需要的功能接口，现在只演示简单的增删改查功能。

package czz.mapper;
    
    import czz.domain.User;
    import org.apache.ibatis.annotations.Param;
    
    public interface UserMapper {
    
        /**
         * 根据主键id查询用户信息
         */
        User getUser(Long id);
    
        /**
         * 新增用户信息
         */
        boolean insertUser(User user);
    
        /**
         * 更新主键id对应的用户信息,@Param注解的作用是给参数命名,参数命名后就能根据名字得到参数值,正确的将参数传入sql语句中.
         * 如果不加，程序会出现找不到user异常
         */
        boolean updateUser(@Param("id") Long id, @Param("user") User user);
    
        /**
         * 删除主键id对应的用户信息
         */
        boolean deleteUser(Long id);
    
    
    }

### 7、添加users表sql的映射文件userMapper.xml ###

userMapper.xml包含UserMapper功能相关的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="czz.mapper.UserMapper">
    
      <resultMap id="User" type="czz.domain.User">
        <id property="id" column="id" javaType="java.lang.Long"></id>
        <result property="account" column="account" javaType="java.lang.String"></result>
        <result property="password" column="password" javaType="java.lang.String"></result>
        <result property="createTime" column="create_time" javaType="java.time.LocalDateTime"></result>
        <result property="updateTime" column="update_time" javaType="java.time.LocalDateTime"></result>
      </resultMap>
    
    
      
      
      <select id="getUser" parameterType="Long" resultMap="User">
            select * from m_user where id = #{id}
        </select>
      
      <insert id="insertUser" useGeneratedKeys="true" keyProperty="id">
            insert into m_user (account,password,create_time,update_time )values (#{account},#{password},#{createTime},#{updateTime})
        </insert>
      
      <update id="updateUser">
          update m_user set account=#{user.account},password=#{user.password},create_time = #{user.createTime} ,update_time= #{user.updateTime} where id=#{id}
        </update>
      
      <delete id="deleteUser" parameterType="Long">
         delete from m_user where id=#{id}
        </delete>
    
    </mapper>

### 8、在conf.xml注册userMapper.xml ###

秩序在conf.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="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"/>
                    <property name="username" value="root"/>
                    <property name="password" value="Jovaunn1"/>
                </dataSource>
            </environment>
        </environments>
    
        <mappers>
            
            <mapper resource="mapperXml/userMapper.xml"/>
    
            
            
            
            
            
            
    
            
        </mappers>
    
    </configuration>

### 9、创建SqlSessionFactory工具类 ###

package czz.factory;
    
    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 java.io.IOException;
    
    /**
     * 从 XML 中构建 SqlSessionFactory，并使用单例设计模式，防止工厂被多次创建,同时可以通过getSession方法获取SqlSession。
     *
     * @author chenzhengzhou
     * @version 1.0
     * @date 2019/3/25 9:21
     */
    public class MybatisFactory {
    
        private MybatisFactory() {
        }
    
        // 利用静态内部类特性实现外部类的单例
        public static class SqlSessionFactoryHolder {
            private static SqlSessionFactory instance;
    
            static {
                try {
                    instance = new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream("conf.xml"));
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    
        /**
         * 获取SqlSessionFactory对象
         *
         * @return SqlSessionFactory实例
         */
        public static SqlSessionFactory getInstance() {
            return SqlSessionFactoryHolder.instance;
        }
    
        /**
         * 通过SqlSessionFactory获取SqlSession
         *
         * @return SqlSession
         */
        public static SqlSession getSqlSession() {
            return SqlSessionFactoryHolder.instance.openSession();
        }
    
    }

### 10、代码测试 ###

在main方法中测试增删改查功能

package czz;
    
    import czz.domain.User;
    import czz.factory.MybatisFactory;
    import czz.mapper.UserMapper;
    import java.time.LocalDateTime;
    import org.apache.ibatis.session.SqlSession;
    
    /**
     * mybatis基本使用方法，这个demo基本上展示了mybatis的大部分使用方法，包括基本的增删改查，联表查询等功能。
     *
     * @author chenzhengzhou
     * @version 1.0
     * @date 2019/3/23 10:34
     */
    public class App {
    
        public static void main(String[] args) {
            SqlSession sqlSession = MybatisFactory.getSqlSession();
    
            try {
    
                UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
                LocalDateTime now = LocalDateTime.now();
                User insertUser = new User();
                insertUser.setAccount("admin");
                insertUser.setPassword("123456");
                insertUser.setCreateTime(now);
                insertUser.setUpdateTime(now);
                userMapper.insertUser(insertUser);
                sqlSession.commit();
                System.out.println("新增用户id：" + insertUser.getId());
                //加这个是为了让之后的更新时间变化更加明显
                Thread.sleep(5000);
                System.out.println("----------------------------------------------------------------");
                User user = userMapper.getUser(insertUser.getId());
                System.out.println("查询用户信息：" + user);
                System.out.println("----------------------------------------------------------------");
                User updateUser = new User();
                updateUser.setAccount("admin2");
                updateUser.setPassword("654321");
                updateUser.setUpdateTime(LocalDateTime.now());
                updateUser.setCreateTime(user.getCreateTime());
                userMapper.updateUser(insertUser.getId(), updateUser);
    
                System.out.println("查询更新后的用户信息：" + userMapper.getUser(insertUser.getId()));
                sqlSession.commit();
                System.out.println("----------------------------------------------------------------");
                userMapper.deleteUser(insertUser.getId());
                sqlSession.commit();
    
                System.out.println("删除用户后查询结果：" + userMapper.getUser(insertUser.getId()));
            } catch (Exception e) {
    
            } finally {
                sqlSession.close();
            }
        }
    }

以上，就是Mybatis最基本的用法，Mybatis其他功能和注意事项之后继续补充。放上某一次运行的结果。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW56ejI1NjA_size_16_color_FFFFFF_t_70 1][]

### 注意： ###

如果使用的是方法2和方法3，可能会在运行时报异常：

Exception in thread "main" org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): czz.study.mapper.UserMapper.getUser
    	at org.apache.ibatis.binding.MapperMethod$SqlCommand.<init>(MapperMethod.java:230)
    	at org.apache.ibatis.binding.MapperMethod.<init>(MapperMethod.java:48)
    	at org.apache.ibatis.binding.MapperProxy.cachedMapperMethod(MapperProxy.java:65)
    	at org.apache.ibatis.binding.MapperProxy.invoke(MapperProxy.java:58)
    	at com.sun.proxy.$Proxy0.getUser(Unknown Source)
    	at czz.study.App.main(App.java:19)

原因是编译class文件时，没有生成对应的xml文件，因为maven默认是不编译的。到编译后查看对应的文件目录，可以发现只有一个class文件，没有对应的xml文件。

![20190110100127801.png][]

解决方式：在pom.xml的<build> </build> 中添加

重新编译，可以发现xml文件出现在对应的位置

![20190110100350546.png][]

[http_www.mybatis.org_mybatis-3_zh_getting-started.html]: http://www.mybatis.org/mybatis-3/zh/getting-started.html
[Mybatis]: /images/20220411/71a0cace956b4a30a77ade4c1bbb058e.png
[IDEA_maven]: https://blog.csdn.net/chenzz2560/article/details/83270232
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW56ejI1NjA_size_16_color_FFFFFF_t_70]: /images/20220411/654be38b0e2d45bb9a390b460fdfc446.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW56ejI1NjA_size_16_color_FFFFFF_t_70 1]: /images/20220411/35a49fd7921f4a0eac60cef1b2c5d895.png
[20190110100127801.png]: /images/20220411/b413fb1e6b8b4ca1979aa933920c8041.png
[20190110100350546.png]: /images/20220411/22d9decb70094e7db2d4d91e7c250696.png