Mybatis 别名的配置 + Mybatis配置类的调查

已于 2023-06-03 18:42:18 修改
阅读量909 收藏 1
点赞数 2
分类专栏： # Mybatis 文章标签： mybatis
于 2023-06-03 11:41:07 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/feyehong/article/details/131017872
版权

参考资料

  1. Mybatis配置类别名
  2. mybatis-spring-boot-autoconfigure
  3. 类型别名（typeAliases）
  4. SpringBoot五步配置Mybatis超简教程
  5. 深入浅出Mybatis系列（四）—配置详解之typeAliases别名（mybatis源码篇）

目录

一. 使用场景

  • 如下面的代码所示，我们通过一个SQL查询数据，返回值类型为Ttag类型，我们需要通过resultType来指定Ttag类的全路径com.example.jmw.entity.alias.Ttag。一两个类还好说，如果使用的实体类数量过多，配置起来就很繁琐，我们需要为每一个类都指定全路径。
  • 这个时候，就可以用到Mybatis的别名配置，我们可以指定实体类指定别名或者指定Mybatis扫描某个包，自动为该包下面的所有实体类都起别名。
<?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.example.jmw.mapper.alias_mapper.TtagMapper">
    <select id="queryAllTtag" resultType="com.example.jmw.entity.alias.Ttag">
        SELECT
          *
        FROM
          t_tag
    </select>
</mapper>

二. 前期准备

2.1 实体类

  • alias包下的实体类
package com.example.jmw.entity.alias;

import lombok.Data;
import org.apache.ibatis.type.Alias;

@Data
@Alias("jmwUser")
public class EnumUser {

    private String name;

    private String sex;
}

package com.example.jmw.entity.alias;

import lombok.Data;

@Data
public class I18message {

    private String code;

    private String locale;

    private String item;
}

package com.example.jmw.entity.alias;

import lombok.Data;

@Data
public class Ttag {

    private String id;

    private String name;
}

2.2 查询接口

import com.example.jmw.entity.alias.EnumUser;
import java.util.List;

public interface EnumUserMapper {

    List<EnumUser> queryAllEnumUser();
}

import com.example.jmw.entity.alias.I18message;
import java.util.List;

public interface I18messageMapper {

    List<I18message> queryAllI18message();
}

import com.example.jmw.entity.alias.Ttag;
import java.util.List;

public interface TtagMapper {

    List<Ttag> queryAllTtag();
}

三. 配置方式1 配置文件的方式

3.1 application.yml文件

  • 如果有多个包的话，中间用，分隔。
mybatis:
    type-aliases-package: com.example.jmw.entity.alias;

3.2 SQL的XMl文件

  • 我们之所以可以把resultType的值配置为jmwUser，是因为我们在EnumUser实体类上配置了@Alias("jmwUser")注解，手动指定了EnumUser实体类的别名。
<mapper namespace="com.example.jmw.mapper.alias_mapper.EnumUserMapper">
    <select id="queryAllEnumUser" resultType="jmwUser">
        SELECT
          *
        FROM
          enumuser
    </select>
</mapper>
  • 如果我们没有通过@Alias注解手动指定别名，默认别名为类的名称，开头字母可以大写，不过推荐使用小写。
<mapper namespace="com.example.jmw.mapper.alias_mapper.I18messageMapper">
    <select id="queryAllI18message" resultType="i18message">
        SELECT
          *
        FROM
          i18message
    </select>
</mapper>
  • 之前的使用全类名的方式，可以和别名的方式混用。
<mapper namespace="com.example.jmw.mapper.alias_mapper.TtagMapper">
    <select id="queryAllTtag" resultType="com.example.jmw.entity.alias.Ttag">
        SELECT
          *
        FROM
          t_tag
    </select>
</mapper>

3.3 效果

在这里插入图片描述

四. 配置方式2 配置类的方式

4.1 创建配置类，实现ConfigurationCustomizer

  • MyBatis-Spring-Boot-Starter 将自动寻找实现了 ConfigurationCustomizer 接口的组件，然后会调用自定义 MyBatis 配置的方法来创建配置类。
  • 接口虽然无法直接实例化，但是可以配合函数式接口，通过lambda表达式的方式创建对象。
import org.apache.ibatis.type.TypeAliasRegistry;
import org.mybatis.spring.boot.autoconfigure.ConfigurationCustomizer;
import org.springframework.context.annotation.Bean;

@org.springframework.context.annotation.Configuration
public class MybatisConfig {

    /*
        ConfigurationCustomizer是一个函数式接口,函数式接口只有一个方法customize(Configuration configuration)
        通过ConfigurationCustomizer来创建Mybatis的配置
    */
    @Bean
    public ConfigurationCustomizer configurationCustomizer() {

        // 下面这种写法是lambda式的简写的方式
        return configuration -> {

            // 打开别名注册类
            TypeAliasRegistry typeAliasRegistry = configuration.getTypeAliasRegistry();
            // 指定包下面所有的实体类都设置别名
            typeAliasRegistry.registerAliases("com.example.jmw.entity.alias");

            // 添加拦截器
            // configuration.addInterceptor();

            // 开启驼峰命名映射
            // configuration.setMapUnderscoreToCamelCase(true);
        };
    }
}

或者可以通过实现接口这种方式

import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.type.TypeAliasRegistry;
import org.mybatis.spring.boot.autoconfigure.ConfigurationCustomizer;

@org.springframework.context.annotation.Configuration
public class MybatisConfig implements ConfigurationCustomizer {

    @Override
    public void customize(Configuration configuration) {
        // 打开别名注册类
        TypeAliasRegistry typeAliasRegistry = configuration.getTypeAliasRegistry();
        // 指定包下面所有的实体类都设置别名
        typeAliasRegistry.registerAliases("com.example.jmw.entity.alias");
        
		// 添加拦截器
        // configuration.addInterceptor();

        // 开启驼峰命名映射
        // configuration.setMapUnderscoreToCamelCase(true);
    }
}

4.2 效果

在这里插入图片描述

五. 原理

由下面的源码截图可知，Mybatis读取我们指定的包的路径，将包中所有的类都添加到别名的HashMap中。

在这里插入图片描述
在这里插入图片描述

六. 注意事项

之前在写这个demo时，遇到通过配置文件和配置类指定别名的时候，无法生效的问题。经过调查之后，发现自己在工程中还配置了Mybatis的拦截器，代码如下：

import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.type.TypeAliasRegistry;
import org.mybatis.spring.SqlSessionFactoryBean;
//import org.mybatis.spring.boot.autoconfigure.SqlSessionFactoryBeanCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.annotation.Resource;
import javax.sql.DataSource;

@Configuration
public class DataSourceConfig {

    // 注入数据源
    @Resource
    private DataSource dataSource;

    // 注入自定义参数拦截器
    @Resource
    private MybatisParamInterceptor paramInterceptor;

    @Bean
    public SqlSessionFactory sqlSessionFactorySecondary() throws Exception {

        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();

        // 设置数据源
        sqlSessionFactoryBean.setDataSource(dataSource);
        // 设置拦截器(可设置多个)
        Interceptor[] plugins = {paramInterceptor};
        sqlSessionFactoryBean.setPlugins(plugins);
        return sqlSessionFactoryBean.getObject();
    }
}

😅😅😅
在此配置类中，我们使用了SqlSessionFactory 来添加Interceptor，将SqlSessionFactory添加到Spring的IOC容器中的这种方式，会导致Mybatis的配置文件或配置类失效。因为无论配置文件还是配置类，最终都是加载到SqlSessionFactory中，如果我们自己手动new一个SqlSessionFactory到Bean中的话，相当于重置了Mybatis为我们自动配置好的SqlSessionFactory。

💪💪💪
官方给我们提供了SqlSessionFactoryBeanCustomizer接口来实现
在这里插入图片描述

fengyehongWorld
关注
  • 2
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
从源码角度探索 Mybatis 插件注册方式
u010141779的博客
12-10 738
通过上一篇博客《深入 Mybatis 插件机制》了解了插件原理，并且 Mybatis 所有插件都保存在 Configuration 的 interceptorChain 属性中，在 Configuration 中提供了注册插件方法 addInterceptor(Interceptor interceptor) 将插件添加到 interceptorChain ，那用户怎么向 Configuration 注册插件呢？ 结合源码，本文分享了四种注册 Mybatis 插件方式： 直接注册到 Spring IOC
MyBatis环境配置及入门
04-13
1、配置文件 Configure.xml 是 mybatis 用来建立 sessionFactory，里面主要包含了数据库连接相关内容，还有 java 类所对应的别名，比如： 这个别名非常重要，在具体的类的映射中，比如：User.xml 中 resultType 就是对应这个。要保持一致，这里的 resultType 还有另外单独的定义方式，后面学习到我们再详细介绍说明。 2、Configure.xml 里面 的是包含要映射的类的 xml 配置文件。 3、在User.xml 文件里面主要是定义各种 SQL 语句，以及这些语句的参数，以及要返回的类型等等。
【SpringBoot的自动配置--上篇】自动配置的本质
Learning_xzj的博客
06-10 1182
Spring Boot最大的功劳就在于自动配置，它的自动配置功能能根据类加载路径下的JAR依赖自动配置基础设施。例如，当Spring Boot检测到类加载路径下包含了MySQL依赖，且容器中没有配置其他任何DataSource时，Spring Boot就会自动启动HSQLDB数据库。 Spring Boot 的自动配置大多会根据特定依赖库自动触发，启用自动配置需要使用@EnableAutoConfiguration注解。注意，整个应用只需要添加一个该注解，因此，通常只要将该注解添加到主配置类（Spring
Mybatis配置类别名
qq_16186465的博客
09-15 2336
Mybatis配置类别名 初学时 在我们一开始学习Mybatis的时候，每次编写一个select都要在返回类型里打一大串包名.类名来指定我们的实体类，就像这样： <select id="getUserList" resultType="com.sanjin.pojo.User"> select * from user </select> 如果每一条查询语句都要这么写，那真是十分的折磨，所以官方就给了我们几种设置别名的方法 配置别名 我们在官方文档的xml配置中，可以看到一个
【Spring Boot】（23）、Spring Boot整合Mybatis
caychen的博客
05-26 691
首先添加mybatis依赖：&lt;dependency&gt; &lt;groupId&gt;org.mybatis.spring.boot&lt;/groupId&gt; &lt;artifactId&gt;mybatis-spring-boot-starter&lt;/artifactId&gt; &lt;version&gt;1.3.2&lt;/version&gt
一个实例带你了解SpringBoot-Mybatis自动配置源码
lengyingzhang的博客
07-10 2019
MyBatis 是一款优秀的持久层框架，Spring Boot官方虽然没有对MyBatis进行整合，但是MyBatis团队自行适配了对应的启动器，进一步简化了使用MyBatis进行数据的操作因为Spring Boot框架开发的便利性，所以实现Spring Boot与数据访问层框架（例如MyBatis）的整合非常简单，主要是引入对应的依赖启动器，并进行数据库相关参数设置即可。 1.新建SpringBoot项目，并引入Mybatis的相关依赖 pom.xml依赖： application.yaml配置： 2.基
Mybatis拦截器源码分析及拦截器应用
ding_hua的博客
11-21 4270
一 、介绍 拦截器简单来说就是可以拦截某些方法，在该方法的执行前后加上某些逻辑来实现我们的需求 二、使用介绍 1.先自定义一个拦截器，实现Interceptor接口,加上注解@Intercepts（{@Signature}） @Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args...
Mybatis/MybatisPlus简述
weixin_64742764的博客
04-21 4247
POJO中标配: @Data @Accessors(chain = true) //重写了set方法. 可以实现链式加载 @NoArgsConstructer //无参构造函数 @AllArgsConstructor //全参数构造函数 implements Serializable 生成序列号
微服务常用组件封装项目过程详细介绍总述(五)---基于springboot的自定义DB starter组件开发
weixin_47407416的博客
12-16 1108
本节将针对上节总增加的immortal-maqiao-core-mybatis 模块进行封装，最终封装成starter组件
Spring Boot 集成 MyBatis 快速入门(注解版 与 xml 配置版)
蚩尤后裔-汪茂雄
08-21 6882
目录 环境准备 新建项目 pom. xml默认结构 Mysql 数据库 全局配置文件 Domain myBatis 注解版 CRUD @Mapper UserController CRUD 测试 MyBatis 自动配置原理 自定义 MyBatis 配置 @MapperScan 批量扫描 2、本文将新建一个 Web 项目，介绍 Spring Boot 整合 MyBat......
MyBatis学习（三）——优化MyBatis的配置文件
12-14
一、properties的配置优化 1.在property属性中如果配置项很多，那么就会让配置文件显得很庞大。 二、为实体类定义别名，简化sql映射xml文件中的引用 ...MyBatis默认的设置别名的方式就是去除类所在的包后的简单的
深入探索MyBatis：全局配置文件解析及应用优化策略
12-13
MyBatis配置文件主要包含数据库连接池配置、SQL语句映射、类型别名定义、插件配置等核心部分。文档首先阐述了MyBatis相较于传统JDBC的优势，如简化数据库操作、提高代码可维护性，并通过配置文件将SQL与Java代码分离...
mybatis 注解别名找不到
04-04
Cause: java.lang.ClassNotFoundException: Cannot find class: student 当你使用mybatis注解别名找不到文件时，在你的mybatis配置文件中加入 注意标签一定要放在标签下面
springboot-mybatis整合多数据源方式之一配置法
03-30
springboot-mybatis整合多数据源方式之一配置法（亦称分包方式）
分布式系统.pptx
04-29
分布式系统.pptx
源代码-360通用ASP防护代码(防sql注入).zip
04-29
源代码-360通用ASP防护代码(防sql注入).zip
node-v8.1.0-darwin-x64.tar.gz
最新发布
04-29
Node.js，简称Node，是一个开源且跨平台的JavaScript运行时环境，它允许在浏览器外运行JavaScript代码。Node.js于2009年由Ryan Dahl创立，旨在创建高性能的Web服务器和网络应用程序。它基于Google Chrome的V8 JavaScript引擎，可以在Windows、Linux、Unix、Mac OS X等操作系统上运行。 Node.js的特点之一是事件驱动和非阻塞I/O模型，这使得它非常适合处理大量并发连接，从而在构建实时应用程序如在线游戏、聊天应用以及实时通讯服务时表现卓越。此外，Node.js使用了模块化的架构，通过npm（Node package manager，Node包管理器）,社区成员可以共享和复用代码，极大地促进了Node.js生态系统的发展和扩张。 Node.js不仅用于服务器端开发。随着技术的发展，它也被用于构建工具链、开发桌面应用程序、物联网设备等。Node.js能够处理文件系统、操作数据库、处理网络请求等，因此，开发者可以用JavaScript编写全栈应用程序，这一点大大提高了开发效率和便捷性。 在实践中，许多大型企业和组织已经采用Node.js作为其Web应用程序的开发平台，如Netflix、PayPal和Walmart等。它们利用Node.js提高了应用性能，简化了开发流程，并且能更快地响应市场需求。
2020年ti杯电赛省赛A题代码整理
04-29
2020年ti杯电赛省赛a题的项目 分为 手机端（android），主显示端，姿态检测手环端，心率滤波读取端 mcu 采用的是esp32.结合了适配esp32的arduino以及rtos框架进行开发。 开发环境 及 语言 安卓为android studio java开发 esp32为platform io c/c++ 节点间通信方式 tcp直连，手机端为总服务端 手机端 android 原生开发 主显示端 屏幕ili9341 spi 触摸xpt2046 图形 adafruit gfx ad芯片 ads112c04 测温 lmt70 姿态检测端 9轴 bno055 心率检测 心电 ads1292
node-v6.15.0-sunos-x64.tar.gz
04-29
Node.js，简称Node，是一个开源且跨平台的JavaScript运行时环境，它允许在浏览器外运行JavaScript代码。Node.js于2009年由Ryan Dahl创立，旨在创建高性能的Web服务器和网络应用程序。它基于Google Chrome的V8 JavaScript引擎，可以在Windows、Linux、Unix、Mac OS X等操作系统上运行。 Node.js的特点之一是事件驱动和非阻塞I/O模型，这使得它非常适合处理大量并发连接，从而在构建实时应用程序如在线游戏、聊天应用以及实时通讯服务时表现卓越。此外，Node.js使用了模块化的架构，通过npm（Node package manager，Node包管理器）,社区成员可以共享和复用代码，极大地促进了Node.js生态系统的发展和扩张。 Node.js不仅用于服务器端开发。随着技术的发展，它也被用于构建工具链、开发桌面应用程序、物联网设备等。Node.js能够处理文件系统、操作数据库、处理网络请求等，因此，开发者可以用JavaScript编写全栈应用程序，这一点大大提高了开发效率和便捷性。 在实践中，许多大型企业和组织已经采用Node.js作为其Web应用程序的开发平台，如Netflix、PayPal和Walmart等。它们利用Node.js提高了应用性能，简化了开发流程，并且能更快地响应市场需求。
Mybatis配置别名typeAliases
05-02
Mybatis中的typeAliases用于给Java类起别名，使得在Mybatis的配置文件中可以使用别名来代替完整的类名。这样做的好处是，可以简化配置文件，提高可读性，并且可以使得类名的修改不会对配置文件造成影响。 typeAliases有两种配置方法，一种是在Mybatis的配置文件中通过typeAliases元素进行配置，另一种是在Java类上通过注解进行配置。 在Mybatis的配置文件中配置typeAliases可以使用以下方式： ``` <typeAliases> <typeAlias alias="User" type="com.example.User"/> <typeAlias alias="Order" type="com.example.Order"/> </typeAliases> ``` 在上面的配置中，alias表示别名，type表示要起别名的Java类的完整类名。 除了直接在配置文件中配置typeAliases外，还可以在Java类上通过注解进行配置，如下所示： ``` @Alias("User") public class User { ... } ``` 在上面的代码中，@Alias注解的值就是User类的别名。 需要注意的是，如果一个Java类的包名和类名都不包含大写字母，则可以省略alias属性，Mybatis会自动将类名转化为小写作为别名。例如，一个名为com.example.user的Java类可以直接写成： ``` <typeAliases> <package name="com.example"/> </typeAliases> ``` 这样就可以在配置文件中使用User代替com.example.user了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值