跳至主要内容

JPA 2.1: Attribute Converter


JPA 2.1: Attribute Converter

If you are using Hibernate, and want a customized type is supported in your Entity class, you could have to write a custom Hibernate Type.
JPA 2.1 brings a new feature named attribute converter, which can help you convert your custom class type to JPA supported type.

Create an Entity

Reuse the Post entity class as example.
@Entity
@Table(name="POSTS")
public class Post implements Serializable {
    private static final long serialVersionUID = 1L;
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Column(name="ID")
    private Long id;
    
    @Column(name="TITLE")
    private String title;
    
    @Column(name="BODY")
    private String body;
    
    @Temporal(javax.persistence.TemporalType.DATE)
    @Column(name="CREATED")
    private Date created;

    @Column(name="TAGS")
    private List<String> tags=new ArrayList<>();
}

Create an attribute converter

In this example, we try to store the tags property into one column instead of an external table.
Create an attribute converter, it should be annotated with @Converter and implementsAttributeConverter interface.
@Converter
public class ListToStringConveter implements AttributeConverter<List<String>, String> {

    @Override
    public String convertToDatabaseColumn(List<String> attribute) {
        if (attribute == null || attribute.isEmpty()) {
            return "";
        }
        return StringUtils.join(attribute, ",");
    }

    @Override
    public List<String> convertToEntityAttribute(String dbData) {
        if (dbData == null || dbData.trim().length() == 0) {
            return new ArrayList<String>();
        }

        String[] data = dbData.split(",");
        return Arrays.asList(data);
    }
}
It is easy to understand, the tags property will be converted into a comma based string when it is stored into database, and tags field value of POSTS table will be converted into a List when it is fetched from database.

Apply Converter

You can use the autoApply attribute of the Converter to apply the converter to any supported type.
@Converter(autoApply=true)
public class ListToStringConveter implements AttributeConverter<List<String>, String> {...}
It is dangerous in a real world project when there are some List you do not want to be converted.
Alternatively, you can apply it on the property via a @Convert annotation.
@Column(name="TAGS")
@Convert(converter = ListToStringConveter.class)
private List<String> tags=new ArrayList<>();
You can also place it on class.
@Converts(value={
    @Convert(attributeName="tags", converter = ListToStringConveter.class)
})
public class Post implements Serializable {...}
An extra attributeName must be specified. You can declare several Converters for properties on an Entity class.
Converters also can be applied on:
  1. @Embeddable key of a OneToMany Map type property.
  2. @Embeded property
  3. @ElementCollection property

Summary

This feature is very useful when you want use a JPA supported type to store your custom class, especially, convert an unsupported type to JPA support type, for example, such as Joda Datetime/Java 8 new Date objects are not supported in JPA 2.1 yet, you can use a converter to convert it to java.util.Date type which is supported by JPA.
The sample codes are hosted on my github.com account, check out and play it yourself.
When you run the project(jpa-converter) on Glassfish 4.0 and you could get an exception.
java.lang.RuntimeException: unable to create policy context directory.
There is a known issue in Glassfish 4.0, the fix should be included in the next release. I am using a Nightly version to overcome this barrier temporarily.

评论

此博客中的热门博文

Build a Reactive application with Angular 5 and Spring Boot 2.0

I have created a post to describe Reactive programming supports in Spring 5 and its subprojects, all codes of this article are updated the latest Spring 5 RELEASE, check spring-reactive-sample under my Github account.
In this post, I will create a simple blog system, including:
A user can sign in and sign out.An authenticated user can create a post.An authenticated user can update a post.Only the user who has ADMIN role can delete a post.All users(including anonymous users) can view post list and post details.An authenticated user can add his comments to a certain post. The backend will be built with the latest Spring 5 reactive stack, including:
Spring Boot 2.0, at the moment the latest version is 2.0.0.M7Spring Data MongoDB supports reactive operations for MongoDBSpring Session adds reactive support for WebSessionSpring Security 5 aligns with Spring 5 reactive stack The frontend is an Angular based SPA and it will be generated by Angular CLI.
The source code is hosted on Github, …

Activating CDI in JSF 2.3

Activating CDI in JSF 2.3 When I upgraed my Java EE 7 sample to the newest Java EE 8, the first thing confused me is the CDI beans are not recoganized in Facelects template in a JSF 2.3 based web applicaiton, which is working in the development version, but in the final release version, they are always resolved as null. I filed an issue on Mojarra and discussed it with the developers from communities and the JSF experts.
According to the content of README, In a JSF 2.3 application, to activate CDI support, declaring a 2.3 versioned faces-config.xml and adding javax.faces.ENABLE_CDI_RESOLVER_CHAIN in web.xml is not enough, you have to declare @FacesConfig annotated class to enable CDI.
Here is the steps I created a workable JSF 2.3 applicatoin in Java EE 8.
Create a Java web application, this can be done easily by NetBeans IDE, or generated by Maven archetype, for exmaple.
$ mvn archetype:generate -DgroupId=com.example -DartifactId=demo -DarchetypeArtifactId=maven-archetype-w…