MyBatis---- Mybatis 注解开发（一）

最新推荐文章于 2023-06-10 21:14:40 发布

近视的脚踏实地

最新推荐文章于 2023-06-10 21:14:40 发布

阅读量391

点赞数

分类专栏： mybatis

本文链接：https://blog.csdn.net/w15977858408/article/details/109674749

版权

mybatis 专栏收录该内容

20 篇文章 1 订阅

订阅专栏

上一篇👉:MyBatis---- Mybatis 缓存

文章目录

1、注解开发的环境搭建
2、注解开发测试使用注意事项

🚴大家好！我是近视的脚踏实地，后边这系列主要是记录自己MyBatis的学习笔记，这篇文章主要来学习Mybatis的注解开发
唯有行动才能解除你所有的不安

1、注解开发的环境搭建

这几年来注解开发越来越流行，Mybatis 也可以使用注解开发方式，这样我们就可以减少编写 Mapper 映射文件了。本次我们先围绕一些基本的 CRUD 来学习，再学习复杂映射关系及延迟加载。

那我们之前在写mybatis的xml配置的时候，是有两个xml的，一个是主配置文件sqlMapConfig.xml，一个映射配置的xml，那么注解开发只是使用注解把映射配置中的内容配置起来，而sqlMapConfig.xml会仍然存在。

mybatis 的常用注解说明👇:

@Insert:实现新增
@Update:实现更新
@Delete:实现删除
@Select:实现查询
@Result:实现结果集封装
@Results:可以与@Result 一起使用，封装多个结果集
@ResultMap:实现引用@Results 定义的封装
@One:实现一对一结果集封装
@Many:实现一对多结果集封装
@SelectProvider: 实现动态 SQL 映射
@CacheNamespace:实现注解二级缓存的使用

那么首先来新创建一个项目，然后首先来导入要用到的jar包的坐标👇:

<?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>monster.zf</groupId>
    <artifactId>day04_mybatis03_annotation</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!--打包方式 -->
    <packaging>jar</packaging>
    <!--导入依赖-->
    <dependencies>

        <!--mybatis依赖-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>

        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.6</version>
        </dependency>

        <!--日志-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

        <!--单元测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>

    </dependencies>


</project>

接着在main，java下创建一个实体类👇:
在这里插入图片描述

package monster.zf.domain;

import java.io.Serializable;
import java.util.Date;

/**
 * @author Monster丶ZF
 * @version 1.8
 * @remakeTodo
 * @Package monster.zf.domain
 * @date 2020/11/13 15:02
 */
public class User implements Serializable {
    private Integer id;
    private String username;
    private Date birthday;
    private String sex;
    private String address;


    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", birthday=" + birthday +
                ", sex='" + sex + '\'' +
                ", address='" + address + '\'' +
                '}';
    }
}

接着是来创建一个UserDao接口👇:
在这里插入图片描述

package monster.zf.dao;

import monster.zf.domain.User;

import java.util.List;

/**
 * @author Monster丶ZF
 * @version 1.8
 * @remakeTodo
 * @Package monster.zf.dao
 * @date 2020/11/13 15:06
 */
public interface UserDao {

    /**
     * 查询所有用户
     * @return
     */
    List<User> findAll();
}

创建对应的映射包，用注解其实可以完全不用他的，为了后边演示细节
在这里插入图片描述
那么接着来创建主配置文件sqlMapConfig.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">

<!--mybatis的主配置文件-->
<configuration>
    <!--配置properties 引入外部配置文件-->
    <properties resource="jdbcConfig.properties"></properties>
    

    <!--使用typeAliase配置别名，它只能配置domain中类的别名 从而让我们在用的过程中少写一些包名和全限定类名-->
    <typeAliases>
        <!--typeAlias用于配置别名，type属性指定的是实体类全限定类名， alias属性指定别名，当指定了别名就不再区分大小写 -->
        <!--<typeAlias type="monster.zf.domain.User" alias="user"></typeAlias>-->
        <!--用于指定要配置别名的包，当指定之后，该包下的实体类都会注册别名，并且类名就是别名，不再区分大小写-->
        <package name="monster.zf.domain"/>
    </typeAliases>


    <!-- 配置环境-->
    <environments default="mysql">
        <!--配置mysql的环境-->
        <environment id="mysql">
            <!-- 配置事务类型 -->
            <transactionManager type="JDBC"></transactionManager>
            <!-- 配置数据源(连接池)-->
            <dataSource type="POOLED">
                <!--配置连接数据库的4个基本信息-->
                <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>

    <!--指定映射配置文件的位置，映射配置文件指的是每个dao独立的配置文件 -->
    <mappers>
        <!-- xml配置方式 -->
        <!--<mapper resource="monster/zf/dao/UserDao.xml"/>-->

        <!-- package用于指定dao接口所在的包，当指定完成之后就不需要在写mapper以及resource或者class了-->
        <package name="monster.zf.dao"/>

    </mappers>

</configuration>

接着把jdbcConfig.properties也写好放进来，以后换数据库直接改这个配置文件就可以了，还有把log4j.properties也放进来
在这里插入图片描述
jdbcConfig.properties👇:

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

log4j.properties👇:

# Set root category priority to INFO and its only appender to CONSOLE.
#log4j.rootCategory=INFO, CONSOLE            debug   info   warn error fatal
log4j.rootCategory=debug, CONSOLE, LOGFILE

# Set the enterprise logger category to FATAL and its only appender to CONSOLE.
log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE

# CONSOLE is set to be a ConsoleAppender using a PatternLayout.
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n

# LOGFILE is set to be a File appender using a PatternLayout.
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=d:\axis.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n

那么环境都搭建好后，就可以开始来写注解了，那么首先在mybatis中针对CRUD，一共有四个注解

@Insert:实现新增
@Update:实现更新
@Delete:实现删除
@Select:实现查询

在这里插入图片描述
那么只有一个值的话，value是可以省略的，直接在里边写sql语句就好

2、注解开发测试使用注意事项

那么接下来我们就去写一个测试类测试一下👇:

package monster.zf.test;

import monster.zf.dao.UserDao;
import monster.zf.domain.User;
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.InputStream;
import java.util.List;

/**
 * @author Monster丶ZF
 * @version 1.8
 * @remakeTodo
 * @Package monster.zf.test
 * @date 2020/11/13 15:28
 */
public class MybatisAnnoTest {

    /**
     *  测试基于注解的mybatis使用
     * @param args
     */
    public static void main(String[] args) throws Exception {

        //1.获取字节输入流
        InputStream in = Resources.getResourceAsStream("sqlMapConfig.xml");
        //2.根据字节输入流构建SqlSessionFactory
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
        //3.根据SqlSessionFactory生产一个SqlSession
        SqlSession seesion = factory.openSession();
        //4.使用SqlSeesion获取Dao代理对象
        UserDao userDao = seesion.getMapper(UserDao.class);
        //5.执行Dao的方法
        List<User> users = userDao.findAll();
        for(User user : users){
            System.out.println(user);
        }
        //6.释放资源
        seesion.close();
        in.close();
    }
}

运行结果👇:
在这里插入图片描述
那么可以发现，我们并没有写UserDao.xml的配置文件，也可以成功地完成功能了，那么我们可以把之前第一天写的那个UserDao导进来，然后看看

之前学过mybatis的自定义，可以知道namespace和id两个属性的值合起来都是它的唯一标志，就是我们要取的时候要用，而里边的resultType部分，还有sql语句部分是我们执行要用的，那么和如下图👇:的注解相比较
在这里插入图片描述
可以看到两种方式的差距还是很大的，差距就在xml里边写了那么多内容，注解一个字母就搞定了，同时它的一个注解还这个xml里边所有的事都说清楚了。

然后首先第一个select注解了哪个方法，我们是知道的，是findAll()方法，然后找到这个方法，就可以同时找到声明这个方法的类以及它的全限定类名。那这两个组合起来就是xml配置中namespace属性的值了，然后方法名就是xml配置中的id属性的值了。

然后第二个就是xml配置中的执行的语句和封装的结果，封装到哪个实体类，那么注解这里就可以明显看到执行语句，那么最后就差一个问题，就是这个返回值，那么其实就是那个泛型User。

其实那么它拿到注解为什么可以实现呢，就是因为他拿到了注解之后就可以把xml配置中定义的所有信息都找到，从这点从出发，注解还是比xml要简单一些的。

下面在讲讲注解使用的一些注意事项👇:
在这里插入图片描述

首先在我们的主配置文件sqlMapConfig.xml中，我们使用了package标签来指定dao接口所在的包，那么就意味着，不管是xml方式还是注解方式，都不需要在写mapper以及resource或者class了，他就是有注解就用注解，有xml就用xml。

但是我们现在注解也有，xml也有，那这个时候mybatis再运行的时候，就会报错👇:
在这里插入图片描述
报错原因是因为已经存在UserDao.xml文件，那么可不可以把它换成class来配置，也就是注解的方式👇:

那么再次运行，很遗憾，还是报错了👇:

那么这其实就是mybatis其中的一个小细节：只要你使用注解开发，但是在你配置文件路径下同时包含了这个xml👇:，此时不管你用不用，它都会报错，就是就算你没有配置mapper标签，它也会报错，这个是mybatis在内部加载的一个实际，就是它发现你有注解了，同时还有xml，它就不知道该以谁为准。
在这里插入图片描述
所以解决方法有两个，要么把UserDao.xml移到一个不相干的路径下去，也就是保证那个路径下没有对应的xml配置文件👇: