hibernate之映射文件VS映射注解

Posted 2020-09-28 窗外天空晴朗

前言

　　对于java开发者而言，注解应该不是一个陌生的概念，早在JavaSE阶段，例如@Override标记重写父类方法或实现接口方法，@Test标记单元测试方法，所以我们可以简单地把它理解为一种有特殊含义的标记...在开发过程中，我们还可以用注解方式替代配置文件实现相关功能，例如Java web开发中，3.0版本后，利用@WebServlet、@WebListener等注解分别可以替代web项目XML配置文件中相关内容。而本文中讲述的就是Hibernate的映射配置文件与映射注解的对比，这两种方式均可以实现映射功能，为了避免先入为主，在此先不阐述孰优孰劣，接下来以实体类基本映射示例，分别用配置文件和注解方式实现。

hibernate.cfg.xml配置文件在使用两种方式时的变动

<?xml version="1.0"?>
<!DOCTYPE hibernate-configuration PUBLIC
    "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
    "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
    <session-factory>
        <!-- 以下四行分别为：数据库驱动类、Drivermanager获取连接的参数URL、用户名、密码  -->
        <property name="connection.driver_class">com.mysql.jdbc.Driver</property>
        <property name="connection.url">jdbc:mysql://127.0.0.1/web?characterEcoding=utf-8</property>
        <property name="connection.username">root</property>
        <property name="connection.password">123456</property>
        <!-- 设置方言，hibernate会根据数据库的类型相应生成SQL语句 -->
        <property name="dialect">org.hibernate.dialect.MySQLDialect</property>
        <!-- 1.使用映射文件时 -->
        <!-- 映射配置源文件的位置 -->
        <mapping resource="demo/pojo/Person.hbm.xml"/>
        <!-- 2.使用映射注解时 -->
        <!-- 注册关系映射类 -->
        <mapping class="demo.pojo.Person" />
    </session-factory>
</hibernate-configuration>

实体类映射

背景：数据库中一个用户表person，字段四个，包涵自增主键id、姓名name、性别sex、年龄age，映射实体类为Person,属性四个，id、name、gender、age。注意这里实体类属性名和数据表中字段名如果不一致，例如这里的sex和gender，在映射文件中<property>标签中name和colum两个属性都要写上，在注解中也不能简化省略@column，column从译意上大家应该都能知道它是对应数据库的字段上，如果不指定字段，默认情况下，系统会把映射文件中的name属性值作为字段名，注解方式时会把属性名作为字段名。另外一个要注意的地方就是类属性是区分大小写的，而字段是不区分大小写的。

映射配置文件

<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC 
    "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
    "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd">
<hibernate-mapping>
    <!-- name是实体类全名，table为数据表名 -->
    <class name="demo.pojo.Person" table="Person">
        <id name="id" column="id">
            <!-- 主键生成方式，native是让hibernate自动识别 -->
            <generator class="native"></generator>
        </id>
        <!-- 
        注意点：
        0.name值为实体类中属性名，column为数据表中字段名；
        1.当实体类中属性名与对应数据表字段名相同时，后面的column可以省略，hibernate会自动匹配，例如下面age ；
        2.反之当实体类中属性名与对应数据表字段名不相同时，两项都要写上，例如下面gender和sex
        -->
        <property name="name" column="name"></property>
        <property name="gender" column="sex"></property>
        <property name="age"></property>
    </class>
</hibernate-mapping>

映射注解方式

package demo.pojo;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
//实体类属性注解，这里统一写在各属性的get方法上
@Entity//标记实体类
@Table(name="person",catalog="web")//name对应数据表名，catalog对应数据库名
public class Person {
    
    private Integer id;
    private String name;
    private String gender;
    private Integer age;
    @Id//标记主键
    @Column(name="id")//主键字段名，这里与类属性id是对应相同的，此行可以简化不写
    @GeneratedValue(strategy=GenerationType.AUTO)//主键生成策略，自动识别
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    @Column(name="name")//主键字段名，这里与类属性name是对应相同的，此行可以简化不写
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    @Column(name="sex")//主键字段名，这里与类属性gender是对应，但不相同，不可省略
    public String getGender() {
        return gender;
    }
    public void setGender(String gender) {
        this.gender = gender;
    }
    //省略注解
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    @Override
    public String toString() {
        return "Person [id=" + id + ", name=" + name + ", gender=" + gender + ", age=" + age + "]";
    }
    
    
}

 

注意点

　　0.在hibernate.cfg.xml配置文件中，使用两种映射方式分别要填映射配置源文件的位置和映射类的全名，一个是<mapping resource="XX/XX/XXX">，一个是<mapping class="XXX.XXX.XXX" />；

　　1.在使用注解方式时，实体类中导入不要导成Hibernate下的，这里引入都是JPA（Java Persistence API）范畴下的类，不要因为是hibernate框架下，顺其自然地以为是那个Hibernate下的类，图示如下

 

小结

　　相较于冗长的一段段代码和各个单独的配置文件，注解无疑会显得小巧方便一些，特别是还有后面的关联映射(一对一、一对多、多对一、多对多)，映射多了，所需要的配置文件更多，使用注解直接省略了这些文件。深入理解好注解对框架的学习也很有帮助，许多框架中都引入了注解的技术，不论是否认可注解的优势，个人认为掌握好注解的使用都是很有必要的。