JPA注解(1)

1. @Temporal

1.1 @Temporal的作用
  数据库中的Date类型，取到页面上是yyyy-MM-dd hh-mm-ss格式，利用@Temporal则可以获取自己想要的格式类型。@Temporal的定义如以下所示：

public @interface Temporal {
    TemporalType value() default TIMESTAMP;
}

默认为TemporalType.TIMESTAMP类型。

TemporalType枚举类型定义如下：

public enum TemporalType {
    DATE, //java.sql.Date
    TIME, //java.sql.Time
    TIMESTAMP //java.sql.Timestamp
}

java.sql.Date、java.sql.Time和java.sql.Timestamp这三种类型不同，它们表示时间的精确度不同。三者的区别如表所示：

    类型                        说明
java.sql.Date           日期型，精确到年月日，例如“2008-08-08”

java.sql.Time           时间型，精确到时分秒，例如“20:00:00”

java.sql.Timestamp      时间戳，精确到纳秒，例如“2008-08-08 20:00:00.000000001”

示例
a. 如果在某类中有Date类型的属性，数据库中存储可能是'yyyy-MM-dd hh:MM:ss'要在查询时获得年月日，在该属性上标注。

@Temporal(TemporalType.DATE)
@Column(name = "applyDate", nullable = false, length = 10)
public Date getApplyDate() {
return applyDate;
}

上述代码在页面端取值：2017-04-12

b. 如果在某类中有Date类型的属性，数据库中存储可能是'yyyy-MM-dd hh:MM:ss'要获得时分秒，在该属性上标注 @Temporal(TemporalType.TIME) 会得到形如'HH:MM:SS' 格式的日期。

@Temporal(TemporalType.TIME)
@Column(name = "applyDate", nullable = false, length = 10)
public Date getApplyDate() {
return applyDate;
}

上述代码在页面端取值：22:50:30

c. 如果在某类中有Date类型的属性，数据库中存储可能是'yyyy-MM-dd hh:MM:ss'要获得'是'yyyy-MM-dd hh:MM:ss'，在该属性上标注 @Temporal(TemporalType.TIMESTAMP) 会得到形如' yyyy-MM-dd hh:MM:ss ' 格式的日期。

@Temporal(TemporalType.TIMESTAMP)
@Column(name = "applyDate", nullable = false, length = 10)
public Date getApplyDate() {
return applyDate;
}

上述代码在页面端取值：2011-04-12 22:51:34.0

2. @Embedded和@Embeddable

在使用实体类生成对应的数据库表时，很多的时候都会遇到这种情况：在一个实体类中引用另外的实体类，一般遇上这种情况，我们使用@OneToOne、@OneToMany、@ManyToOne、@ManyToMany这4个注解比较多，但是好奇害死猫，除了这四个有没有别的使用情况，尤其是一个实体类要在多个不同的实体类中进行使用，而本身又不需要独立生成一个数据库表，这就是需要@Embedded、@Embeddable的时候了，下面分成4类来说明在一个实体类中引用另外的实体类的情况。
  使用的两个实体类如下：
Address类：

public class Address implements Serializable{
    private static final long serialVersionUID = 8849870114128959929L;
 
    private String country;
    private String province;
    private String city;
    private String detail;
 
    //setter、getter
}

Person类：

@Entity
public class Person implements Serializable{
    private static final long serialVersionUID = 8849870114127659929L;
 
    @Id
    @GeneratedValue
    private Long id;
 
    @Column(nullable = false)
    private String name;
 
    @Column(nullable = false)
    private Integer age;
 
    private Address address;
 
    //setter、getter
}

1、 两个注解全不使用
  当这两个注解都不使用时，那么两个实体类和上面的相同，那么生成的表结构如下：


2、 只使用@Embeddable
  我们在Address实体类上加上@Embeddable注解，变成如下类：

@Embeddable
public class Address implements Serializable{
    private static final long serialVersionUID = 8849870114128959929L;
 
    private String country;
    private String province;
    private String city;
    private String detail;
 
    //setter、getter
}

而Person实体类不变，生成的数据库表结构如下：



可以看出这次是把Address中的字段映射成数据库列嵌入到Person表中了，而这些字段的类型和长度也使用默认值。如果我们在Address中的字段中设置列的相关属性，则会按照我们设定的值去生成，如下Address类：

@Embeddable
public class Address implements Serializable{
    private static final long serialVersionUID = 8849870114128959929L;
 
    @Column(nullable = false)
    private String country;
    @Column(length = 30)
    private String province;
    @Column(unique = true)
    private String city;
    @Column(length = 50)
    private String detail;
    //setter、getter
}

生成的表结构如下：

我们在Address中配置的属性全部成功映射到Person表中。

3. 只使用@Embedded

这里我们只在Person中使用@Embedded,如下：

@Entity
public class Person implements Serializable{
    private static final long serialVersionUID = 8849870114127659929L;
 
    @Id
    @GeneratedValue
    private Long id;
 
    @Column(nullable = false)
    private String name;
 
    @Column(nullable = false)
    private Integer age;
 
    @Embedded
    private Address address;
 
    //setter、getter
}

Adddress类和最开始的不同POJO类相同，此时生成的表结构如下：



可以看出这个表结构和在Address中只使用@Embeddable注解时相同，在进入深一步试验，我们在Address中加入列属性，但是不使用@Embeddable注解会发生什么？Address类如下：

public class Address implements Serializable{
    private static final long serialVersionUID = 8849870114128959929L;
 
    @Column(nullable = false)
    private String country;
    @Column(length = 30)
    private String province;
    @Column(unique = true)
    private String city;
    @Column(length = 50)
    private String detail;
    //setter、getter
}

生成数据表结构如下：



所以只使用@Embedded和只使用@Embeddable产生的效果是相同的。

4. 两个注解全使用
  既然单独使用@Embedded或者只使用@Embeddable都会产生作用，那么这两个都使用效果也一定是一样的，我们平时也是这么用的。所以在这部分我们就不演示和上面相同的效果了，而是说两个深入的话题。

4.1 覆盖@Embeddable类中字段的列属性
  这里就要使用另外的两个注解@AttributeOverrides和@AttributeOverride，这两个注解是用来覆盖@Embeddable类中字段的属性的。

  • @AttributeOverrides：里面只包含了@AttributeOverride类型数组；
  • @AttributeOverride：包含要覆盖的@Embeddable类中字段名name和新增的@Column字段的属性；

Person类如下：

@Entity
public class Person implements Serializable{
    private static final long serialVersionUID = 8849870114127659929L;
 
    @Id
    @GeneratedValue
    private Long id;
 
    @Column(nullable = false)
    private String name;
 
    @Column(nullable = false)
    private Integer age;
 
    @Embedded
    @AttributeOverrides(
       {@AttributeOverride(name="country", 
             column=@Column(name = "person_country", length = 25, nullable = false)),
        @AttributeOverride(name="city", 
             column = @Column(name = "person_city", length = 15))
       })
    private Address address;
 
    //setter、getter
}

Address类如下：

@Embeddable
public class Address implements Serializable{
    private static final long serialVersionUID = 8849870114128959929L;
 
    @Column(nullable = false)
    private String country;
    @Column(length = 30)
    private String province;
    @Column(unique = true)
    private String city;
    @Column(length = 50)
    private String detail;
    //setter、getter
}

生成的数据表如下：


可以看出我们的@AttributeOverrides和@AttributeOverride两个注解起作用了。

4.2 多层嵌入实体类属性
  上面所有的例子都是使用两层实体类嵌入，其实这种实体类的嵌入映射是可以使用多层的，具体的例子如下。
  我们新建立一个类Direction表示方位如下：

@Embeddable
public class Direction implements Serializable{
 
    @Column(nullable = false)
    private Integer longitude;
    private Integer latitude;
}

Address如下：

@Embeddable
public class Address implements Serializable{
    private static final long serialVersionUID = 8849870114128959929L;
 
    @Column(nullable = false)
    private String country;
    @Column(length = 30)
    private String province;
    @Column(unique = true)
    private String city;
    @Column(length = 50)
    private String detail;
 
    @Embedded
    private Direction direction;
}

Person类如下：

@Entity
public class Person implements Serializable{
    private static final long serialVersionUID = 8849870114127659929L;
 
    @Id
    @GeneratedValue
    private Long id;
 
    @Column(nullable = false)
    private String name;
 
    @Column(nullable = false)
    private Integer age;
 
    @Embedded
    @AttributeOverrides(
          {@AttributeOverride(name="direction.latitude",
                column=@Column(name = "person_latitude")),
           @AttributeOverride(name="direction.longitude", 
                column = @Column(name = "person_longitude"))})
    private Address address;
}

生成的数据表如下：


在上面需要注意如下几点：

  • 在Person中定义Direction中的属性时，需要用”.”将所有相关的属性连接起来；
  • 在Direction中longitude属性定义为not null，但是由于使用了@AttributeOverride注解，其中虽然没有定义null属性，但是这时使用的是默认的nullable属性，默认为true;

3. @Convert

介绍@Convert之前首先介绍实体属性类型转换器AttributeConverter。接口AttributeConverter<x, y>用于转化实体属性的，但id属性和关系属性不可用。它有两个方法：

  • y convertToDatabaseColumn(x) 作用：将实体属性x转化为y存储到数据库中，即插入和更新操作时执行；
  • x convertToEntityAttribute(y) 作用：将数据库中的字段y转化为实体属性x，即查询操作时执行

而@Convert用于注解在需要类型转换的字段上，将一个基本数据类型转换为另一个基本数据类型。

【示例】
** 示例1**
步骤一：创建StatusEnum

public enum StatusEnum {

    ENABLE(1, "启用"), DISABLE(-1, "禁用"), DELETED(-2, "已删除");

    StatusEnum(Integer value, String description) {
        this.value = value;
        this.description = description;
    }
}

步骤二：实现AttributeConverter<String, Integer>接口，将代表数字与描述进行转换，其中实体类中的status字段为String类型。

public class StatusAttributeConverter implements AttributeConverter<String, Integer> {
    @Override
    public Integer convertToDatabaseColumn(String status) {
        try {
           //如果是数字，则直接返回（这里可以遍历StatusEnum的value来进一步验证）
           return Integer.parseInt(status);
        } catch (NumberFormatException e) {
           //如果不是数字，则通过StatusEnum来找到描述对应的数字
            for (StatusEnum type : StatusEnum.values()) { 
                if (status.equals(type.getDescription()))
                    return type.getValue();
            }
        }
        //如果StatusEnum里不存在代表数字或描述，则抛出异常
        throw new RuntimeException("Unknown StatusEnum: " + status);
    }

    @Override
    public String convertToEntityAttribute(Integer value) {
        //将数字转换为描述
        for (StatusEnum type : StatusEnum.values()) {
            if (value.equals(type.getValue())) {
                return type.getDescription();
            }
        }
        throw new RuntimeException("Unknown database value: " + value);
    }
}

步骤三：实体类

@Entity
@Table(name = "t_demo")
public class DemoEntity {
    @Convert(converter = StatusAttributeConverter.class)
    private String status; //状态：1 启用，-1 禁用，-2 已删除
}

示例2
将一个基本数据类型转换为另一个基本数据类型。

public class Demo
{
  @Column(length=2048, columnDefinition="text")
  @Convert(converter=com.sys.jpa.JSONObjectSerializeConvert.class)
  protected JSONObject smeta;
   
   //getter、setter
}

@Converter
public class JSONObjectSerializeConvert
    implements AttributeConverter<JSONObject, String>
{
    @Override
    public String convertToDatabaseColumn(JSONObject attribute)
    {
        return(
            attribute!=null ? attribute.toJSONString() : null
        );
    }

    @Override
    public JSONObject convertToEntityAttribute(String dbData)
    {
        return(
            dbData!=null ? JSON.parseObject(dbData) : null
        );
    }
}
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 205,033评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 87,725评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,473评论 0赞 338
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,846评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,848评论 5赞 368
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,691评论 1赞 282
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,053评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,700评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 42,856评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2赞 323
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,430评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,034评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2赞 352
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2赞 343

推荐阅读更多精彩内容

  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,598评论 18赞 139
  • Spring boot参考指南
    Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,744评论 6赞 342
  • 面向对象的用电信息数据交换协议
    国家电网公司企业标准（Q/GDW）- 面向对象的用电信息数据交换协议 - 报批稿：20170802 前言： 排版 ...
    庭说阅读 10,865评论 6赞 13
  • 01-jun-2017
    儿童节快乐！今天去了操人，新工作室。还有沉思自己的交易系统
    DeathKnightR阅读 159评论 0赞 0
  • 2016.1.22
    王蛋蛋小朋友22天。趁着爸比在家，中午带着王蛋蛋去洗了澡，从出院至今，小朋友这才第一次洗澡，书上说对于每天要拉五六...
    王蛋蛋的日常阅读 97评论 0赞 0