MyBatis之注解开发

除了XML映射方式，MyBatis还支持注解方式实现POJO对象和数据表之间的关联映射，使用注解的方式一般将SQL语句直接写到接口上。与XML的映射方式相比，基于注解的映射方式相对简单。Mybatis提供的注解有：

1.环境准备

1.1 数据库准备

 

USE mybatis;
# 创建一个名称为tb_worker的表
CREATE TABLE  tb_worker( 
     id INT PRIMARY KEY AUTO_INCREMENT,
     name VARCHAR(32),
     age INT,
     sex VARCHAR(8),
     worker_id INT UNIQUE     
);
# 插入2条数据
INSERT INTO tb_worker(name,age,sex,worker_id)VALUES('张三',32,'女',1001);
INSERT INTO tb_worker(name,age,sex,worker_id)VALUES('李四',29,'男',1002);
INSERT INTO tb_worker(name,age,sex,worker_id)VALUES('王五',26,'男',1003);

1.2 Idea基础环境

1.2.1 创建annotaion module

1.2.2 pom.xml引入依赖 

<?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">
    <parent>
        <artifactId>mybatis-series</artifactId>
        <groupId>com.biem</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>annotation</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.18</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.16</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.16</version>
        </dependency>
    </dependencies>
</project>

1.2.3 创建资源

包：4个

(1) src/main/java下创建

com.biem.pojo
com.biem.mapper
com.biem.util

 (2) src/test/java下创建

类：4个

(1) com.biem.pojo.Worker.java

package com.biem.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.Getter;
import lombok.NoArgsConstructor;

/**
 * ClassName: Worker
 * Package: com.biem.pojo
 * Description:
 *
 * @Create 2023/5/19 8:27
 * @Version 1.0
 */
@Data
//@Data ： 注在类上，提供类的get、set、equals、hashCode、canEqual、toString方法
@NoArgsConstructor
@AllArgsConstructor
public class Worker {
    private Integer id;
    private String name;
    private Integer age;
    private String sex;
    private Integer workerId;
}

(2) com.biem.mapper.WorkerMapper.java

package com.biem.mapper;

/**
 * ClassName: WorkerMapper
 * Package: com.biem.mapper
 * Description:
 *
 * @Create 2023/5/19 8:27
 * @Version 1.0
 */
public interface WorkerMapper {
}

(3) com.biem.util.MyBatisUtil.java

package com.biem.util;

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;
import java.io.InputStream;

/**
 * ClassName: MybatisUtil
 * Package: com.biem.util
 * Description:
 *
 * @Create 2023/4/5 22:23
 * @Version 1.0
 */
public class MyBatisUtil {
    //利用static(静态)属于类不属于对象,且全局唯一
    private static SqlSessionFactory sqlSessionFactory = null;
    //利用静态块在初始化类时实例化sqlSessionFactory
    static {
        InputStream is= null;
        try {
            is = Resources.getResourceAsStream("mybatis-config.xml");
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        } catch (IOException e) {
            e.printStackTrace();
            throw new ExceptionInInitializerError(e);
        }
    }

    /**
     * openSession 创建一个新的SqlSession对象
     * @return SqlSession对象
     */
    public static SqlSession openSession(boolean autoCommit){
        return sqlSessionFactory.openSession(autoCommit);
    }

    public static SqlSession openSession(){
        return sqlSessionFactory.openSession();
    }
    /**
     * 释放一个有效的SqlSession对象
     * @param session 准备释放SqlSession对象
     */
    public static void closeSession(SqlSession session){
        if(session != null){
            session.close();
        }
    }
}

(4) com.biem.test.WorkerTest.java

package com.biem.test;

/**
 * ClassName: WorkerTest
 * Package: com.biem.test
 * Description:
 *
 * @Create 2023/5/19 9:21
 * @Version 1.0
 */
public class WorkerTest {
}

配置：3个

(1) jdbc.properties

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC
jdbc.username=root
jdbc.password=root

(2) log4j.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
        <param name="Encoding" value="UTF-8"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS} %m (%F:%L) \n"/>
        </layout>
    </appender>
    <logger name="java.sql">
        <level value="debug"/>
    </logger>
    <logger name="org.apache.ibatis">
        <level value="info"/>
    </logger>
    <root>
        <level value="debug"/>
        <appender-ref ref="STDOUT"/>
    </root>
</log4j:configuration>

(3) mybatis-config.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>
    <!--引入properties文件-->
    <properties resource="jdbc.properties"></properties>

    <!--将下划线映射为驼峰-->
    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>

    <!--设置类型别名-->
    <typeAliases>
        <package name="com.biem.pojo"/>
    </typeAliases>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>

    </environments>

    <!-- 引入映射文件 -->
    <mappers>
        <package name="com.biem.mapper"/>
    </mappers>

</configuration>

2.常用注解

2.1 @Select注解

2.1.1 com.biem.mapper.WorkerMapper.java下添加

    @Select("select * from tb_worker where id=#{id}")
    public Worker findWorkerById(Integer id);

2.1.2 com.biem.test.WorkerTest.java下添加

    @Test
    public void findWorkerById(){
        SqlSession session = MyBatisUtil.openSession();
        WorkerMapper mapper = session.getMapper(WorkerMapper.class);
        System.out.println("mapper.findWorkerById(1) = " + mapper.findWorkerById(1));
        session.close();
    }

2.1.3 输出结果

 

2.2 @Insert注解

2.2.1 com.biem.mapper.WorkerMapper.java下添加

    @Insert("insert into tb_worker(name, age, sex, worker_id) values(#{name}, #{age}, #{sex}, #{workerId})")
    public int insertWorker(Worker worker);

2.2.2 com.biem.test.WorkerTest.java下添加

    @Test
    public void inserWorker(){
        SqlSession session = MyBatisUtil.openSession();
        WorkerMapper mapper = session.getMapper(WorkerMapper.class);
        Worker worker = new Worker();
        worker.setName("王强");
        worker.setAge(36);
        worker.setSex("女");
        worker.setWorkerId(1004);
        int result = mapper.insertWorker(worker);
        session.commit();
        session.close();
    }

2.2.3 输出结果

 

2.3 @Update注解

2.3.1 com.biem.mapper.WorkerMapper.java下添加

    @Update("update tb_worker set name=#{name},age=#{age} where id = #{id}")
    public int updateWorker(Worker worker);

2.3.2 com.biem.test.WorkerTest.java下添加

    @Test
    public void updateWorker(){
        SqlSession session = MyBatisUtil.openSession();
        WorkerMapper mapper = session.getMapper(WorkerMapper.class);
        Worker worker = new Worker();
        worker.setId(4);
        worker.setName("王冰");
        worker.setAge(36);
        int result = mapper.updateWorker(worker);
        if(result>0){
            System.out.println("更新了"+result+"条数据");
        } else {
            System.out.println("更新失败");
        }
        session.commit();
        session.close();
    }

2.3.3 输出结果

 

2.4 @Delete注解

2.4.1 com.biem.mapper.WorkerMapper.java下添加

    @Delete("delete from tb_worker where id=#{id}")
    public int deleteWorkerById(Integer id);

2.4.2 com.biem.test.WorkerTest.java下添加

    @Test
    public void deleteWorkerById(){
        SqlSession session = MyBatisUtil.openSession();
        WorkerMapper mapper = session.getMapper(WorkerMapper.class);
        int result = mapper.deleteWorkerById(4);
        if(result>0){
            System.out.println("删除了"+result+"条数据");
        } else {
            System.out.println("删除失败");
        }
        session.close();
    }

2.4.3 输出结果

 

 

2.5 @Param注解

@Param注解的作用是指定SQL语句中的参数，通常用于SQL语句中参数比较多的情况。

2.4.1 com.biem.mapper.WorkerMapper.java下添加

    //mybatis不能识别多个参数,所以多个参数会抛出，
    //Cause: org.apache.ibatis.binding.BindingException: Parameter 'id' not found. Available parameters are [arg1, arg0, param1, param2]
    @Select("select * from tb_worker where id=#{id} and name=#{name}")
    public Worker findWorkerByIdAndName1(Integer id, String name);

    @Select("select * from tb_worker where id=#{param1} and name=#{param2}")
    public Worker findWorkerByIdAndName2(@Param("param1") Integer id, @Param("param2") String name);

    @Select("select * from tb_worker where id=#{arg1} and name=#{arg0}")
    public Worker findWorkerByIdAndName3(@Param("arg1") Integer id, @Param("arg0") String name);

2.4.2 com.biem.test.WorkerTest.java下添加

    @Test
    public void findWorkerByIdAndName1(){
        SqlSession session = MyBatisUtil.openSession();
        WorkerMapper mapper = session.getMapper(WorkerMapper.class);
        System.out.println("mapper.findWorkerByIdAndName1(1,\"张三\") = " + mapper.findWorkerByIdAndName1(1, "张三"));
        session.close();
    }

    @Test
    public void findWorkerByIdAndName2(){
        SqlSession session = MyBatisUtil.openSession();
        WorkerMapper mapper = session.getMapper(WorkerMapper.class);
        System.out.println("mapper.findWorkerByIdAndName2(1,\"张三\") = " + mapper.findWorkerByIdAndName2(1, "张三"));
        session.close();
    }

    @Test
    public void findWorkerByIdAndName3(){
        SqlSession session = MyBatisUtil.openSession();
        WorkerMapper mapper = session.getMapper(WorkerMapper.class);
        System.out.println("mapper.findWorkerByIdAndName3(1,\"张三\") = " + mapper.findWorkerByIdAndName3(1, "张三"));
        session.close();
    }

2.4.3 输出结果

(1) findWorkerByIdAndName1结果

 

 

(2) findWorkerByIdAndName2结果

 

(3) findWorkerByIdAndName3结果