Mybatis实体类和表映射

本文介绍当实体类属性与数据库表字段不匹配时,如何使用MyBatis进行正确映射,包括通过SQL别名及<resultMap>元素实现。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Mybatis实体类和表映射

在平时的开发中,我们表中的字段名和表对应实体类的属性名称不一定都是完全相同的,下面来演示一下这种情况下的如何解决字段名与实体类属性名不相同的冲突。

一、准备演示需要使用的表和数据

CREATE TABLE orders(
    order_id INT PRIMARY KEY AUTO_INCREMENT,
    order_no VARCHAR(20), 
    order_price FLOAT
);
INSERT INTO orders(order_no, order_price) VALUES('aaaa', 23);
INSERT INTO orders(order_no, order_price) VALUES('bbbb', 33);
INSERT INTO orders(order_no, order_price) VALUES('cccc', 22);

二、定义实体类

package me.gacl.domain;

/**
 * @author gacl
 * 定义orders表对应的实体类
 */
public class Order {
    /**
     * 
    CREATE TABLE orders(
        order_id INT PRIMARY KEY AUTO_INCREMENT,
        order_no VARCHAR(20), 
        order_price FLOAT
    );
     */

    //Order实体类中属性名和orders表中的字段名是不一样的
    private int id;                //id===>order_id
    private String orderNo;        //orderNo===>order_no
    private float price;        //price===>order_price

    public int getId() {
        return id;
    }

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

    public String getOrderNo() {
        return orderNo;
    }

    public void setOrderNo(String orderNo) {
        this.orderNo = orderNo;
    }

    public float getPrice() {
        return price;
    }

    public void setPrice(float price) {
        this.price = price;
    }

    @Override
    public String toString() {
        return "Order [id=" + id + ", orderNo=" + orderNo + ", price=" + price+ "]";
    }
}

三、编写测试代码

3.1、编写SQL的xml映射文件

1、创建一个orderMapper.xml文件,orderMapper.xml的内容如下:

<?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的值是唯一的
例如namespace="me.gacl.mapping.orderMapper"就是me.gacl.mapping(包名)+orderMapper(orderMapper.xml文件去除后缀)
 -->
<mapper namespace="me.gacl.mapping.orderMapper">

    <!-- 
        根据id查询得到一个order对象,使用这个查询是查询不到我们想要的结果的,
        这主要是因为实体类的属性名和数据库的字段名对应不上的原因,因此无法查询出对应的记录
     -->
    <select id="getOrderById" parameterType="int" 
        resultType="me.gacl.domain.Order">
        select * from orders where order_id=#{id}
    </select>

    <!-- 
        根据id查询得到一个order对象,使用这个查询是可以正常查询到我们想要的结果的,
        这是因为我们将查询的字段名都起一个和实体类属性名相同的别名,这样实体类的属性名和查询结果中的字段名就可以一一对应上
     -->
    <select id="selectOrder" parameterType="int" 
        resultType="me.gacl.domain.Order">
        select order_id id, order_no orderNo,order_price price from orders where order_id=#{id}
    </select>

    <!-- 
    根据id查询得到一个order对象,使用这个查询是可以正常查询到我们想要的结果的,
    这是因为我们通过<resultMap>映射实体类属性名和表的字段名一一对应关系 -->
    <select id="selectOrderResultMap" parameterType="int" resultMap="orderResultMap">
        select * from orders where order_id=#{id}
    </select>
    <!--通过<resultMap>映射实体类属性名和表的字段名对应关系 -->
    <resultMap type="me.gacl.domain.Order" id="orderResultMap">
        <!-- 用id属性来映射主键字段 -->
        <id property="id" column="order_id"/>
        <!-- 用result属性来映射非主键字段 -->
        <result property="orderNo" column="order_no"/>
        <result property="price" column="order_price"/>
    </resultMap>

</mapper>

2、在conf.xml文件中注册orderMapper.xml映射文件

<mappers>        
        <!-- 注册orderMapper.xml文件, 
        orderMapper.xml位于me.gacl.mapping这个包下,所以resource写成me/gacl/mapping/orderMapper.xml-->
        <mapper resource="me/gacl/mapping/orderMapper.xml"/>
</mappers>
3.2、编写单元测试代码
package me.gacl.test;

import me.gacl.domain.Order;
import me.gacl.util.MyBatisUtil;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

public class Test2 {

    @Test
    public void testGetOrderById(){
        SqlSession sqlSession = MyBatisUtil.getSqlSession();
        /**
         * 映射sql的标识字符串,
         * me.gacl.mapping.orderMapper是orderMapper.xml文件中mapper标签的namespace属性的值,
         * getOrderById是select标签的id属性值,通过select标签的id属性值就可以找到要执行的SQL
         */
        String statement = "me.gacl.mapping.orderMapper.getOrderById";//映射sql的标识字符串
        //执行查询操作,将查询结果自动封装成Order对象返回
        Order order = sqlSession.selectOne(statement,1);//查询orders表中id为1的记录
        //使用SqlSession执行完SQL之后需要关闭SqlSession
        sqlSession.close();
        System.out.println(order);//打印结果:null,也就是没有查询出相应的记录
    }

    @Test
    public void testGetOrderById2(){
        SqlSession sqlSession = MyBatisUtil.getSqlSession();
        /**
         * 映射sql的标识字符串,
         * me.gacl.mapping.orderMapper是orderMapper.xml文件中mapper标签的namespace属性的值,
         * selectOrder是select标签的id属性值,通过select标签的id属性值就可以找到要执行的SQL
         */
        String statement = "me.gacl.mapping.orderMapper.selectOrder";//映射sql的标识字符串
        //执行查询操作,将查询结果自动封装成Order对象返回
        Order order = sqlSession.selectOne(statement,1);//查询orders表中id为1的记录
        //使用SqlSession执行完SQL之后需要关闭SqlSession
        sqlSession.close();
        System.out.println(order);//打印结果:Order [id=1, orderNo=aaaa, price=23.0]
    }

    @Test
    public void testGetOrderById3(){
        SqlSession sqlSession = MyBatisUtil.getSqlSession();
        /**
         * 映射sql的标识字符串,
         * me.gacl.mapping.orderMapper是orderMapper.xml文件中mapper标签的namespace属性的值,
         * selectOrderResultMap是select标签的id属性值,通过select标签的id属性值就可以找到要执行的SQL
         */
        String statement = "me.gacl.mapping.orderMapper.selectOrderResultMap";//映射sql的标识字符串
        //执行查询操作,将查询结果自动封装成Order对象返回
        Order order = sqlSession.selectOne(statement,1);//查询orders表中id为1的记录
        //使用SqlSession执行完SQL之后需要关闭SqlSession
        sqlSession.close();
        System.out.println(order);//打印结果:Order [id=1, orderNo=aaaa, price=23.0]
    }
}

执行单元测试的结果:

  1、testGetOrderById方法执行查询后返回一个null。

  2、testGetOrderById2方法和testGetOrderById3方法执行查询后可以正常得到想要的结果。

四、总结

上面的测试代码演示当实体类中的属性名和表中的字段名不一致时,使用MyBatis进行查询操作时无法查询出相应的结果的问题以及针对问题采用的两种办法:

解决办法一: 通过在查询的sql语句中定义字段名的别名,让字段名的别名和实体类的属性名一致,这样就可以表的字段名和实体类的属性名一一对应上了,这种方式是通过在sql语句中定义别名来解决字段名和属性名的映射关系的。

解决办法二: 通过来映射字段名和实体类属性名的一一对应关系。这种方式是使用MyBatis提供的解决方式来解决字段名和属性名的映射关系的。

原文地址:http://www.cnblogs.com/xdp-gacl/p/4264425.html

<think>首先,用户的问题是:“请问Java MyBatis 实体类与数据库映射方法”,意思是询问在MyBatis框架中如何映射实体类数据库的列。 根据系统级指令: - 所有行内数学达式必须使用$...$格式,但这里没有数学达式,所以不需要。 - 独立公式使用$$...$$格式,但同样,这里可能没有。 - LaTeX语法正确:确保在需要时使用正确的LaTeX。 - 使用中文回答:整个回答要用中文。 - 生成相关问题:在回答结束后,生成相关问题。 - 回答中引用的段落末尾自然地添加引用标识:例如[^1]。但用户提供了引用[1]到[4],我需要引用这些内容。 用户提供了引用: - [^1]: 关于Mybatis实体类数据库字段的映射方式,包括TypeHandlerRegistryResultSetHandler。 - [^2]: 关于springboot+mybatis通过实体类自动生成数据库的方法。 - [^3]: 关于Mybatis中的实体属性与数据库字段的映射。 - [^4]: 关于@Mapper@Select注解的使用。 用户说:“上述引用仅供参考,并不是用户真正的需求,请尽可能多的参考用户上一次的问题你的回答。” 但在这个对话中,没有“上一次的问题”,因为这是新的查询。用户提到“用户上一次的问题”,但在这个上下文中,可能是指当前的问题。用户说:“我想用户希望了解如何在Java MyBatis框架中实现实体类与数据库及列映射。” 所以,我应该专注于回答这个问题。 关键点:用户想知道如何实现实体类与数据库映射。 从MyBatis的知识中,我知道有几种方式: 1. **默认映射**:如果实体类的属性数据库的列相同,MyBatis会自动映射。 2. **使用ResultMap**:在XML映射文件中定义<resultMap>来指定列属性映射。 3. **使用注解**:在Mapper接口中使用@Results@Result注解来定义映射。 4. **自动生成**:如引用[2]提到的,通过实体类自动生成数据库,但这通常是在数据库设计时,而不是在MyBatis映射时。 5. **其他配置**:如TypeHandler处理类型转换。 用户提供的引用: - [^1]:提到了ORM映射的两个过程:jdbcTypejavaType映射(通过TypeHandlerRegistry),以及propertyNamecolumnName映射(通过ResultSetHandler)。 - [^3]:讨论了实体属性与数据库字段的映射,默认情况下是自动映射的。 - [^4]:提到了@Mapper@Select注解,其中@Select可以用于简单查询。 所以,在回答时,我应该整合这些信息。 回答结构: 1. **介绍**:简要解释MyBatis中的映射。 2. **方法**:详细说明几种映射方法。 - 默认映射(基于称匹配)。 - 使用ResultMap(XML配置)。 - 使用注解(如@Results)。 - 其他方式,如使用别或全局配置。 3. **示例**:提供代码示例,使回答更清晰。 4. **引用**:在相关部分末尾添加引用标识。 5. **结束**:总结。 然后,生成相关问题。 最后,确保回答结构清晰,帮助用户逐步解决问题。 大纲: - 步骤1:解释基本映射概念。 - 步骤2:描述默认映射。 - 步骤3:描述使用ResultMap。 - 步骤4:描述使用注解。 - 步骤5:提到自动生成数据库(如果相关)。 - 步骤6:总结最佳实践。 - 生成相关问题。 代码示例:由于用户提供了引用,我可以参考它们。例如,在描述ResultMap时,引用[1]或[3]。 在回答中,自然地添加引用标识。例如,当提到某个概念时,添加[^1]在句子末尾。 例如:"MyBatis通过TypeHandlerRegistry处理类型映射[^1]。" 现在,构建回答。</think>### Java MyBatis 实体类与数据库映射方法 在Java MyBatis框架中,实体类(Entity Class)与数据库及列映射是实现ORM(对象关系映射)的核心功能。MyBatis提供了多种灵活的方式来实现这种映射,确保Java对象与数据库记录之间的无缝转换。以下将逐步介绍主要方法,结合代码示例说明。映射的关键在于处理**属性(propertyName)** 与**列(columnName)** 的对应关系,以及类型转换(jdbcType到javaType)[^1]。 #### 1. **默认映射(基于称匹配)** - **原理**:如果实体类的属性与数据库的列完全一致(忽略大小写),MyBatis会自动完成映射。无需额外配置。 - **示例**: - 实体类定义: ```java public class User { private Integer id; // 属性与列相同 private String name; // 属性与列相同 // gettersetter方法 } ``` - 数据库结构: ```sql CREATE TABLE user ( id INT PRIMARY KEY, name VARCHAR(50) ); ``` - Mapper XML查询: ```xml <select id="selectUser" resultType="com.example.User"> SELECT id, name FROM user </select> ``` - 这里,`resultType="com.example.User"` MyBatis会自动将查询结果映射到User对象的属性中[^3]。 - **优点**:简单快捷,适用于命规范的场景。 - **缺点**:当属性与列不一致时,无法正确映射。 #### 2. **使用ResultMap(XML配置方式)** - **原理**:在Mapper XML文件中定义`<resultMap>`标签,显式指定列与属性映射关系。这是最常用的自定义映射方式,支持复杂映射(如关联查询)。 - **步骤**: 1. 定义`<resultMap>`,指定`id`(唯一标识)`type`(实体类全限定)。 2. 使用`<result>`标签为每个属性配置映射。 - **示例**: - 实体类(属性与列不一致): ```java public class Employee { private Integer empId; // 属性: empId private String empName; // 属性: empName // gettersetter方法 } ``` - 数据库结构: ```sql CREATE TABLE employee ( employee_id INT PRIMARY KEY, // 列: employee_id employee_name VARCHAR(50) // 列: employee_name ); ``` - Mapper XML配置: ```xml <resultMap id="employeeMap" type="com.example.Employee"> <id property="empId" column="employee_id" /> <!-- 主键映射 --> <result property="empName" column="employee_name" /> <!-- 普通列映射 --> </resultMap> <select id="selectEmployee" resultMap="employeeMap"> SELECT employee_id, employee_name FROM employee </select> ``` - 这里,`<resultMap>`定义了`employee_id`列映射到`empId`属性,`employee_name`列映射到`empName`属性。查询时使用`resultMap`引用该映射[^1][^3]。 - **优点**:灵活性强,支持复杂对象(如嵌套ResultMap)。 - **适用场景**:大型项目或数据库实体类差异大的情况。 #### 3. **使用注解方式(Mapper接口中定义)** - **原理**:在Mapper接口的方法上使用MyBatis注解(如`@Results``@Result`),直接在Java代码中定义映射关系。适用于简单查询或偏好代码配置的场景。 - **关键注解**: - `@Results`:定义一组映射规则。 - `@Result`:指定单个属性的映射。 - `@Select`:定义SQL查询。 - **示例**: - Mapper接口: ```java @Mapper public interface EmployeeMapper { @Results(id = "empMap", value = { @Result(property = "empId", column = "employee_id"), // 列映射到属性 @Result(property = "empName", column = "employee_name") }) @Select("SELECT employee_id, employee_name FROM employee") List<Employee> selectAll(); } ``` - 这里,`@Results`注解定义了与ResultMap等效的映射规则。`@Mapper`示这是一个MyBatis Mapper接口,由框架自动生成实现类[^4]。 - **优点**:简洁,无需XML文件,适合微服务或Spring Boot项目。 - **缺点**:复杂映射时代码可读性较差。 #### 4. **其他辅助方法** - **全局配置(自动映射策略)**: - 在MyBatis配置文件中(如`mybatis-config.xml`),设置`mapUnderscoreToCamelCase`为`true`,自动将下划线命(如`employee_name`)转换为驼峰命(如`employeeName`)。 ```xml <settings> <setting name="mapUnderscoreToCamelCase" value="true"/> </settings> ``` - 这样,实体类属性`empName`会自动映射到列`employee_name`[^3]。 - **使用SQL别**: - 在查询SQL中为列指定别,使其匹配实体类属性。 ```sql SELECT employee_id AS empId, employee_name AS empName FROM employee ``` - **自动生成数据库(反向工程)**: - 如引用[2]所述,结合Spring Boot工具(如MyBatis Generator或Liquibase),可以从实体类自动创建数据库。这不是映射的直接方法,但在开发初期可确保命一致性[^2]。 #### 总结与最佳实践 - **默认映射**:适合简单场景,属性与列一致。 - **ResultMap或注解**:推荐用于复杂或命不一致的映射,ResultMap更灵活,注解更简洁。 - **性能注意**:ResultMap在初始化时解析,可能影响启动性能,但运行时高效[^1]。 - **最佳实践**: - 优先使用ResultMap处理复杂关系。 - 在Spring Boot项目中,结合`@MapperScan`简化配置。 - 确保TypeHandlerRegistry正确处理类型转换(如日期或枚举)[^1]。 通过上述方法,MyBatis能高效实现实体类与数据库的映射,提升开发效率。如有疑问,可参考MyBatis官方文档或相关工具集成。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值