Hibernate学习笔记单表映射

ゞ浴缸里的玫瑰 2022-07-13 11:43 220阅读 0赞

## 建立实体类 ##

配置好SessionFactory之后，我们就可以开始建立一对一的单表映射了。首先需要建立一个实体类，这里Getter、Setter、toString、equals等方法省略了。我们可以方便的使用IDEA或者Eclipse的生成代码功能轻松生成。

package yitian.data;
    
    import java.util.Date;
    
    public class User { 
        private int id;
        private String username;
        private String password;
        private String nickname;
        private Gender gender;
        private String address;
        private Date birthday;
        private Date registerTime;
    
    }

性别是一个枚举：

package yitian.data;
    
    
    public enum Gender {
        FEMALE,
        MALE
    }

## 建立映射 ##

有两种方法来建立实体类与数据库之间的映射。第一种方法是建立一个映射文件，映射文件名类似于`Entity.hbm.xml`，也是一个xml文件，其中定义了实体类和数据表之间的关系。这是一种传统方式，缺点是需要一个额外的配置文件，而且XML配置容易出错，如果放置位置不对的话还会导致找不到文件。所以现在第二种方式使用的更多。

现在更流行的方式是使用JPA注解。JPA是一个Java EE标准，定义了一组注解，将注解配置到实体类上，就可以建立实体类和数据表之间的映射。下面就是一个使用注解配置的实体类：

package yitian.data;
    
    
    import org.hibernate.annotations.GenericGenerator;
    import org.hibernate.annotations.NaturalId;
    
    import javax.persistence.*;
    import java.util.Date;
    import java.util.Objects;
    
    @Entity
    @Table(name = "user")
    public class User { 
        private int id;
        private String username;
        private String password;
        private String nickname;
        private Gender gender;
        private String address;
        private Date birthday;
        private Date registerTime;
    
        public User() {
        }
    
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        public int getId() {
    
            return id;
        }
    
        public void setId(int id) {
            this.id = id;
        }
    
        @NaturalId
        public String getUsername() {
            return username;
        }
    
        public void setUsername(String username) {
            this.username = username;
        }
    
        @Column
        public String getPassword() {
            return password;
        }
    
        public void setPassword(String password) {
            this.password = password;
        }
    
        @Column
        public String getNickname() {
            return nickname;
        }
    
        public void setNickname(String nickname) {
            this.nickname = nickname;
        }
    
        @Column
        @Enumerated(EnumType.STRING)
        public Gender getGender() {
            return gender;
        }
    
        public void setGender(Gender gender) {
            this.gender = gender;
        }
    
        @Column
        public String getAddress() {
            return address;
        }
    
        public void setAddress(String address) {
            this.address = address;
        }
    
        @Column
        public Date getBirthday() {
            return birthday;
        }
    
        public void setBirthday(Date birthday) {
            this.birthday = birthday;
        }
    
        @Column(name = "register_time")
        @Temporal(TemporalType.DATE)
        public Date getRegisterTime() {
            return registerTime;
        }
    
        public void setRegisterTime(Date registerTime) {
            this.registerTime = registerTime;
        }
    
        @Override
        public boolean equals(Object o) {
    
            if (this == o) return true;
            if (o == null || getClass() != o.getClass()) return false;
            User user = (User) o;
            return id == user.id &&
                    Objects.equals(username, user.username) &&
                    Objects.equals(password, user.password) &&
                    Objects.equals(nickname, user.nickname) &&
                    gender == user.gender &&
                    Objects.equals(address, user.address) &&
                    Objects.equals(birthday, user.birthday) &&
                    Objects.equals(registerTime, user.registerTime);
        }
    
        @Override
        public int hashCode() {
            return Objects.hash(id, username, password, nickname, gender, address, birthday, registerTime);
        }
    
        @Override
        public String toString() {
            return "User{" +
                    "id=" + id +
                    ", username='" + username + '\'' +
                    ", password='" + password + '\'' +
                    ", nickname='" + nickname + '\'' +
                    ", gender=" + gender +
                    ", address='" + address + '\'' +
                    ", birthday=" + birthday +
                    ", registerTime=" + registerTime +
                    '}';
        }
    }

使用到的注解如下：

*  Entity和Table注解用来标记实体类。默认情况下表名和实体类名相同，如果希望自定义表名使用Table注解并设置相应的name属性。
 *  Id注解标明了主键。GeneratedValue表示自动生成主键，生成策略默认为AUTO，表示由Hibernate根据数据库类型自动选择合适的策略。如果希望在不同数据库之间有更好的可移植性，就选择默认策略。
 *  NaturalId指定实体类的自然主键。一般情况下推荐使用无意义的数字作为主键，但是有时候类似于用户名、书籍编号这样的属性也具有主键的意义。这时候我们将这些属性定义为自然主键。同样可以向主键使用，更为方便。
 *  Column将对应的实体类属性映射到数据表的列上，可以添加name参数自定义数据表的列名。
 *  Temporal表示这一列数据是一个日期类型，具体的日期类型由TemporalType枚举表示，有DATE、TIME、TIMESTAMP三个类型，表示三种日期类型。
 *  Enumerated用来映射枚举类型，可以使用EnumType枚举定义如何映射枚举，如果是`EnumType.ORDINAL`，那么就会使用枚举对应的数字，如果使用`EnumType.STRING`，就会使用枚举对应的名称。

注解即可以放在字段上，也可以放在方法上。如果放在字段上，Hibernate就会使用字段对数据进行操作。如果放在方法上，Hibernate就使用方法操作数据。不论哪种都是可以的，但是需要注意保持一致性，不能混用。Hibernate检索的依据是Id注解的位置，如果Id放在了方法上而其他注解放在了字段上，Hibernate就会忽略字段上的所有注解，反之亦然。推荐将注解放在方法上，因为如果方法中进行了额外的操作，我们就可以保证这些操作能够正确的执行。

上面这个实体类基本上涵盖了常用的类型映射和方法。我们做一个简单的小程序完全够用了。不过仅仅添加注解还是不够的，我们需要向`hibernate.cfg.xml`中添加一句，表示我们使用注解配置了某个类。

这样，我们的Hibernate的单表映射就配置完成了。

## CRUD ##

CRUD也就是英文的增删查改的意思，我们配置好单表映射之后，就可以利用Hibernate提供的方法方便的操作数据了。

### 添加 ###

Hibernate支持事务，因此在添加数据之前需要新建一个事务，添加完数据之后需要提交事务。这一点在代码中很清楚。如果事务失败，可以使用rollback()方法回滚事务，返回到操作之前的状态。

添加数据使用save方法。这个方法很简单，直接看代码就可以了。

@Test
        public void testAdd() {
            User user = new User();
            user.setUsername("yitian");
            user.setPassword("12345678");
            user.setBirthday(new Date());
            user.setGender(Gender.MALE);
            user.setRegisterTime(new Date());
    
            try (Session session = factory.openSession()) {
                session.beginTransaction();
                session.save(user);
                session.getTransaction().commit();
    
            }
    
            try (Session session = factory.openSession()) {
                Query<User> query = session.createQuery("from User");
                List<User> users = query.list();
                Assert.assertNotNull(users);
            }
        }

### 查询 ###

Hibernate支持多种查询操作。这里仅仅用了最简单的HQL语句，查询性别为男的所有人。详细的查询方法会在后面说明。

@Test
        public void testQuery() {
            try (Session session = factory.openSession()) {
                Query<User> findAllMan = session.createQuery("from User u where u.gender='MALE'");
                List<User> users = findAllMan.list();
                Assert.assertNotNull(users);
                logger.debug(users.toString());
            }
        }

### 更新 ###

更新使用update()方法，首先需要取出一个对象，修改属性之后在使用update方法更新到数据库中。不要忘了提交事务。

@Test
        public void testUpdate() {
            try (Session session = factory.openSession()) {
                session.beginTransaction();
                User u = session.bySimpleNaturalId(User.class).load("zhang3");
                u.setEmail("zhang3m@yitian.com");
                session.update(u);
                session.getTransaction().commit();
                u = session.bySimpleNaturalId(User.class).load("zhang3");
                Assert.assertEquals(u.getEmail(), "zhang3m@yitian.com");
    
            }
        }

### 删除 ###

删除方法是delete()，传输要删除的对象，然后提交事务即可。

@Test
        public void testDelete() {
            User user = new User();
            user.setUsername("wuli");
            user.setNickname("呜呜呜");
            try (Session session = factory.openSession()) {
                session.beginTransaction();
                session.save(user);
                session.getTransaction().commit();
    
                User u = session.bySimpleNaturalId(User.class).load("wuli");
                logger.debug(u.toString());
                Assert.assertNotNull(u);
                session.beginTransaction();
                session.delete(u);
                session.getTransaction().commit();
                u = session.bySimpleNaturalId(User.class).load("wuli");
                Assert.assertNull(u);
            }
        }

这里还使用到了bySimpleNaturalId方法。如果实体类中只定义了一个自然主键，就可以使用这个方法然后使用load方法获取自然主键对应的对象。

以上就是Hibernate单表映射的简单例子。代码没有给完全，主要看一看Hibernate的运行模式即可。看到这里，大家应该对Hibernate有了大致的了解。