MyBatis查詢數(shù)據(jù)庫操作自定義字段名稱方式

更新時間：2025年05月19日 10:10:12 作者：CnLg.NJ

這篇文章主要介紹了MyBatis查詢數(shù)據(jù)庫操作自定義字段名稱方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

基于 XML 映射文件的 Mapper

當(dāng)使用 XML 映射文件來定義 Mapper 時，可以在 SQL 語句里使用 字段 AS xx 語法。

示例代碼

Mapper 接口

import java.util.List;
import java.util.Map;

public interface UserMapper {
    List<Map<String, Object>> selectUsersWithAlias();
}

Mapper XML 文件（UserMapper.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="com.example.mapper.UserMapper">
    <select id="selectUsersWithAlias" resultType="java.util.Map">
        SELECT user_id AS id, user_name AS name
        FROM users
    </select>
</mapper>

代碼調(diào)用示例

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;
import java.util.Map;

public class Main {
    public static void main(String[] args) throws Exception {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper userMapper = session.getMapper(UserMapper.class);
            List<Map<String, Object>> users = userMapper.selectUsersWithAlias();
            for (Map<String, Object> user : users) {
                System.out.println("ID: " + user.get("id") + ", Name: " + user.get("name"));
            }
        }
    }
}

代碼解釋

在 UserMapper.xml 文件的 select 語句中，使用 user_id AS id 和 user_name AS name 對字段進行了重命名。
resultType="java.util.Map" 表示查詢結(jié)果會以 Map 的形式返回，其中鍵為字段名（使用 AS 后的別名），值為字段值。

基于注解的 Mapper

若使用注解來定義 Mapper，同樣可以在 SQL 注解里使用 字段 AS xx 語法。

示例代碼

import org.apache.ibatis.annotations.Select;
import java.util.List;
import java.util.Map;

public interface UserMapper {
    @Select("SELECT user_id AS id, user_name AS name FROM users")
    List<Map<String, Object>> selectUsersWithAlias();
}

代碼解釋

在 @Select 注解的 SQL 語句中，使用 AS 關(guān)鍵字對字段進行了重命名。
方法返回類型為 List<Map<String, Object>>，查詢結(jié)果中的字段名會以 AS 后的別名存在于 Map 中。

映射到實體類

當(dāng)把查詢結(jié)果映射到實體類時，AS 后的別名要和實體類的屬性名一致，這樣 MyBatis 才能正確映射。

示例代碼

實體類

public class User {
    private Integer id;
    private String name;

    // Getters and Setters
    public Integer getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

Mapper 接口

import java.util.List;

public interface UserMapper {
    List<User> selectUsersWithAlias();
}

Mapper XML 文件（UserMapper.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="com.example.mapper.UserMapper">
    <select id="selectUsersWithAlias" resultType="com.example.entity.User">
        SELECT user_id AS id, user_name AS name
        FROM users
    </select>
</mapper>

代碼解釋

在 select 語句中使用 AS 關(guān)鍵字將 user_id 重命名為 id，user_name 重命名為 name，與 User 實體類的屬性名一致。
resultType="com.example.entity.User" 表示查詢結(jié)果會映射到 User 實體類。