Mybatis配置之<typeAliases>別名配置元素解析
在前面的文章<Mybatis配置之<properties>屬性配置元素詳述>,我們講述了<properties>標簽元素的配置和使用方法。
在這篇文章中,我們來說說<typeAliases>標簽元素,這個元素主要是用于對類型進行別名控制,具體什么意思呢?我們下面用一個示例說明,看了之后我相信你就會明白了。
這里我們貼出之前的UserDao對應(yīng)的mapper文件
如下所示:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
<mapper namespace="com.majing.learning.mybatis.dao.UserDao">
<select id="findUserById" resultType="com.majing.learning.mybatis.entity.User">
select * from user where id = #{id}
</select>
<insert id="addUser" parameterType="com.majing.learning.mybatis.entity.User" useGeneratedKeys="true" keyProperty="id">
insert into user(name,password,age) values(#{name},#{password},#{age})
</insert>
<delete id="deleteUser" parameterType="int">
delete from user where id = #{id}
</delete>
<update id="updateUser" parameterType="com.majing.learning.mybatis.entity.User">
update user set name = #{name}, password = #{password}, age = #{age} where id = #{id}
</update>
</mapper>
從這個配置文件中,我們可以看到<select>、<insert>和<update>三個標簽元素的resultType都是User對象,需要設(shè)置這個User對象的類全限定名,即packname.classname。
我們發(fā)現(xiàn)一個問題,那就是這個類名,我們需要寫多次,如果要改這個類名的話,我們需要在多個地方進行修改。
很明顯,這樣配置的話很容易造成修改上的遺漏,同時也書寫上也比較麻煩。
因此,MyBatis為我們提供了一個簡單方便的配置方法,那就是使用<typeAliases>標簽元素,給實體類設(shè)置一個別名。
<?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 resource="mysql.properties">
<property name="username" value="root"/>
<property name="password" value="root"/>
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8"/>
</properties>
<settings>
<setting name="logImpl" value="LOG4J" />
</settings>
<typeAliases>
<typeAlias alias="User" type="com.majing.learning.mybatis.entity.User"/>
</typeAliases>
<!-- 和spring整合后 environments配置將廢除 -->
<environments default="development">
<environment id="development">
<!-- 使用jdbc事務(wù)管理 -->
<transactionManager type="JDBC" />
<!-- 數(shù)據(jù)庫連接池 -->
<dataSource type="POOLED">
<property name="driver" value="${driver}" />
<property name="url" value="${url}" />
<property name="username" value="${username}" />
<property name="password" value="${password}" />
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com\majing\learning\mybatis\dao\UserDaoMapper.xml" />
</mappers>
</configuration>
如上所示,我們在原來的mybatis配置文件中增加了<typeAliases>標簽,并將com.majing.learning.mybatis.entity.User這個實體類重命名為User,然后我們在mapper配置文件中就可以如下使用了。
備注:這里需要注意的是,typeAliases配置需要放置在settings之后,否則會出異常!??!
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
<mapper namespace="com.majing.learning.mybatis.dao.UserDao">
<select id="findUserById" resultType="User">
select * from user where id = #{id}
</select>
<insert id="addUser" parameterType="User" useGeneratedKeys="true" keyProperty="id">
insert into user(name,password,age) values(#{name},#{password},#{age})
</insert>
<delete id="deleteUser" parameterType="int">
delete from user where id = #{id}
</delete>
<update id="updateUser" parameterType="User">
update user set name = #{name}, password = #{password}, age = #{age} where id = #{id}
</update>
</mapper>
這樣即使實體類名修改了,所需要修改的地方也只有一處,便于集中管理。
也許你會有疑問,如果實體類比較多怎么辦?還不是要配置很多實體類和別名,NO,NO,NO!下面跟大家說說另一種配置方法。
<?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 resource="mysql.properties">
<property name="username" value="root"/>
<property name="password" value="root"/>
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8"/>
</properties>
<settings>
<setting name="logImpl" value="LOG4J" />
</settings>
<typeAliases>
<package name="com.majing.learning.mybatis.entity"/>
</typeAliases>
<!-- 和spring整合后 environments配置將廢除 -->
<environments default="development">
<environment id="development">
<!-- 使用jdbc事務(wù)管理 -->
<transactionManager type="JDBC" />
<!-- 數(shù)據(jù)庫連接池 -->
<dataSource type="POOLED">
<property name="driver" value="${driver}" />
<property name="url" value="${url}" />
<property name="username" value="${username}" />
<property name="password" value="${password}" />
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com\majing\learning\mybatis\dao\UserDaoMapper.xml" />
</mappers>
</configuration>
在這里,我們不再使用<typeAliases>標簽下<typeAliase>,而是使用<package>標簽,表示掃描該包名下的所有類(除了接口和匿名內(nèi)部類),如果類名上有注解,則使用注解指定的名稱作為別名,如果沒有則使用類名首字母小寫作為別名,如com.majing.learning.mybatis.entity.User這個類如果沒有設(shè)置@Alias注解,則此時會被關(guān)聯(lián)到user這個別名上。
因此,按照上面的配置,我們還需要將實體類做一下調(diào)整,如下兩種方式所示:
(1)給實體類添加@Alias注解
package com.majing.learning.mybatis.entity;
import org.apache.ibatis.type.Alias;
@Alias(value="User")
public class User {
private int id;
private String name;
private String password;
private int age;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
@Override
public String toString() {
return "User [id=" + id + ", name=" + name + ", password=" + password + ", age=" + age + "]";
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
(2)實體類不加注解的情況下
修改mapper文件中引用的類型別名,改為小寫,如下所示:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
<mapper namespace="com.majing.learning.mybatis.dao.UserDao">
<select id="findUserById" resultType="user">
select * from user where id = #{id}
</select>
<insert id="addUser" parameterType="user" useGeneratedKeys="true" keyProperty="id">
insert into user(name,password,age) values(#{name},#{password},#{age})
</insert>
<delete id="deleteUser" parameterType="int">
delete from user where id = #{id}
</delete>
<update id="updateUser" parameterType="user">
update user set name = #{name}, password = #{password}, age = #{age} where id = #{id}
</update>
</mapper>
最后想說,mybatis為我們已經(jīng)實現(xiàn)了很多別名,已經(jīng)為許多常見的 Java 類型內(nèi)建了相應(yīng)的類型別名。
它們都是大小寫不敏感的,需要注意的是由基本類型名稱重復(fù)導致的特殊處理。
| 別名 | 映射的類型 |
|---|---|
| _byte | byte |
| _long | long |
| _short | short |
| _int | int |
| _integer | int |
| _double | double |
| _float | float |
| _boolean | boolean |
| string | String |
| byte | Byte |
| long | Long |
| short | Short |
| int | Integer |
| integer | Integer |
| double | Double |
| float | Float |
| boolean | Boolean |
| date | Date |
| decimal | BigDecimal |
| bigdecimal | BigDecimal |
| object | Object |
| map | Map |
| hashmap | HashMap |
| list | List |
| arraylist | ArrayList |
| collection | Collection |
| iterator | Iterator |
至此,關(guān)于別名的全部使用方法這里便介紹完成了,是不是很簡單啊~
Mybatis別名的配置(兩種方法)
對于mapper的映射xml文件
sql語句中存在著resultType。
修改前:寫了接受實體類的全限定名

在mybatis的配置文件中添加
位置需要添加在configtion的標簽下面;
<configuration>
<typeAliases>
<typeAlias type="com.uu.bean.News" alias="jj"/>
</typeAliases>
修改后:
添加后在mapper的映射文件中全限定名中改為了配置的簡單的別名。

第二種方式:
在代碼中:
import org.apache.ibatis.type.Alias;
@Alias("jj")
public class News {
在配置文件中:
<configuration>
<typeAliases>
<package name="com.uu.bean"/>
</typeAliases>
可以達到與配置中聲名相同的效果。
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
Spring Security Remember me使用及原理詳解
這篇文章主要介紹了Spring Security Remember me使用及原理詳解,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-09-09
Spring Security基于過濾器實現(xiàn)圖形驗證碼功能
驗證碼就是為了防止惡意用戶采用暴力重試的攻擊手段而設(shè)置的一種防護措施,接下來在Spring Security的環(huán)境中,我們可以用兩種方案實現(xiàn)圖形驗證碼,具體實現(xiàn)方法跟隨小編一起看看吧2021-09-09
SpringBoot中EasyExcel實現(xiàn)execl導入導出
本文主要介紹了SpringBoot中EasyExcel實現(xiàn)execl導入導出,實現(xiàn)了如何準備環(huán)境、創(chuàng)建實體類、自定義轉(zhuǎn)換器以及編寫導入邏輯的步驟和示例代碼,感興趣的可以了解下2023-06-06
如何使用Idea中的 Deployment 實現(xiàn)打包自動部署
這篇文章主要介紹了使用Idea中的 Deployment 實現(xiàn)打包自動部署,本文通過圖文并茂的形式給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-08-08

