PostgreSQL DB (9.2)에 JSON 유형의 열이있는 테이블이 있습니다. 이 열을 JPA2 엔터티 필드 유형에 매핑하는 데 어려움이 있습니다.
String을 사용하려고했지만 엔티티를 저장할 때 JSON으로 다양한 문자를 변환 할 수 없다는 예외가 발생합니다.
JSON 열을 처리 할 때 사용할 올바른 값 유형은 무엇입니까?
@Entity
public class MyEntity {
private String jsonPayload; // this maps to a json column
public MyEntity() {
}
}
간단한 해결 방법은 텍스트 열을 정의하는 것입니다.
답변:
PostgreSQL은 데이터 유형 변환에 대해 지나치게 엄격합니다. 그것은 암시 적 캐스팅하지 않습니다 text심지어 텍스트와 같은 같은 값으로 xml와 json.
이 문제를 해결하는 가장 정확한 방법은 JDBC setObject메소드 를 사용하는 커스텀 Hibernate 매핑 유형을 작성하는 것입니다. 이것은 다소 번거로울 수 있으므로 약한 캐스트를 생성하여 PostgreSQL을 덜 엄격하게 만들고 싶을 수 있습니다.
댓글 및 이 블로그 게시물 에서 @markdsievers가 언급했듯이이 답변의 원래 솔루션은 JSON 유효성 검사를 우회합니다. 그래서 그것은 당신이 원하는 것이 아닙니다. 다음과 같이 작성하는 것이 더 안전합니다.
CREATE OR REPLACE FUNCTION json_intext(text) RETURNS json AS $$
SELECT json_in($1::cstring);
$$ LANGUAGE SQL IMMUTABLE;
CREATE CAST (text AS json) WITH FUNCTION json_intext(text) AS IMPLICIT;
AS IMPLICIT PostgreSQL에 명시 적으로 지시하지 않고 변환 할 수 있도록 지시하여 다음과 같은 작업을 허용합니다.
regress=# CREATE TABLE jsontext(x json);
CREATE TABLE
regress=# PREPARE test(text) AS INSERT INTO jsontext(x) VALUES ($1);
PREPARE
regress=# EXECUTE test('{}')
INSERT 0 1
문제를 지적 해 주신 @markdsievers에게 감사드립니다.
cstring어쨌든 변환 을 거치고 있으므로 단순히 사용할 수 CREATE CAST (text AS json) WITH INOUT없습니까?
관심이 있으시다면 Hibernate 커스텀 사용자 유형을 가져 오는 몇 가지 코드 스 니펫이 있습니다. JAVA_OBJECT 포인터에 대한 Craig Ringer 덕분에 먼저 PostgreSQL 언어를 확장하여 json 유형에 대해 알려줍니다.
import org.hibernate.dialect.PostgreSQL9Dialect;
import java.sql.Types;
/**
* Wrap default PostgreSQL9Dialect with 'json' type.
*
* @author timfulmer
*/
public class JsonPostgreSQLDialect extends PostgreSQL9Dialect {
public JsonPostgreSQLDialect() {
super();
this.registerColumnType(Types.JAVA_OBJECT, "json");
}
}
다음으로 org.hibernate.usertype.UserType을 구현합니다. 아래 구현은 문자열 값을 json 데이터베이스 유형에 매핑하고 그 반대의 경우도 마찬가지입니다. Java에서 문자열은 변경할 수 없습니다. 더 복잡한 구현을 사용하여 사용자 지정 Java Bean을 데이터베이스에 저장된 JSON에 매핑 할 수도 있습니다.
package foo;
import org.hibernate.HibernateException;
import org.hibernate.engine.spi.SessionImplementor;
import org.hibernate.usertype.UserType;
import java.io.Serializable;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Types;
/**
* @author timfulmer
*/
public class StringJsonUserType implements UserType {
/**
* Return the SQL type codes for the columns mapped by this type. The
* codes are defined on <tt>java.sql.Types</tt>.
*
* @return int[] the typecodes
* @see java.sql.Types
*/
@Override
public int[] sqlTypes() {
return new int[] { Types.JAVA_OBJECT};
}
/**
* The class returned by <tt>nullSafeGet()</tt>.
*
* @return Class
*/
@Override
public Class returnedClass() {
return String.class;
}
/**
* Compare two instances of the class mapped by this type for persistence "equality".
* Equality of the persistent state.
*
* @param x
* @param y
* @return boolean
*/
@Override
public boolean equals(Object x, Object y) throws HibernateException {
if( x== null){
return y== null;
}
return x.equals( y);
}
/**
* Get a hashcode for the instance, consistent with persistence "equality"
*/
@Override
public int hashCode(Object x) throws HibernateException {
return x.hashCode();
}
/**
* Retrieve an instance of the mapped class from a JDBC resultset. Implementors
* should handle possibility of null values.
*
* @param rs a JDBC result set
* @param names the column names
* @param session
* @param owner the containing entity @return Object
* @throws org.hibernate.HibernateException
*
* @throws java.sql.SQLException
*/
@Override
public Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner) throws HibernateException, SQLException {
if(rs.getString(names[0]) == null){
return null;
}
return rs.getString(names[0]);
}
/**
* Write an instance of the mapped class to a prepared statement. Implementors
* should handle possibility of null values. A multi-column type should be written
* to parameters starting from <tt>index</tt>.
*
* @param st a JDBC prepared statement
* @param value the object to write
* @param index statement parameter index
* @param session
* @throws org.hibernate.HibernateException
*
* @throws java.sql.SQLException
*/
@Override
public void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) throws HibernateException, SQLException {
if (value == null) {
st.setNull(index, Types.OTHER);
return;
}
st.setObject(index, value, Types.OTHER);
}
/**
* Return a deep copy of the persistent state, stopping at entities and at
* collections. It is not necessary to copy immutable objects, or null
* values, in which case it is safe to simply return the argument.
*
* @param value the object to be cloned, which may be null
* @return Object a copy
*/
@Override
public Object deepCopy(Object value) throws HibernateException {
return value;
}
/**
* Are objects of this type mutable?
*
* @return boolean
*/
@Override
public boolean isMutable() {
return true;
}
/**
* Transform the object into its cacheable representation. At the very least this
* method should perform a deep copy if the type is mutable. That may not be enough
* for some implementations, however; for example, associations must be cached as
* identifier values. (optional operation)
*
* @param value the object to be cached
* @return a cachable representation of the object
* @throws org.hibernate.HibernateException
*
*/
@Override
public Serializable disassemble(Object value) throws HibernateException {
return (String)this.deepCopy( value);
}
/**
* Reconstruct an object from the cacheable representation. At the very least this
* method should perform a deep copy if the type is mutable. (optional operation)
*
* @param cached the object to be cached
* @param owner the owner of the cached object
* @return a reconstructed object from the cachable representation
* @throws org.hibernate.HibernateException
*
*/
@Override
public Object assemble(Serializable cached, Object owner) throws HibernateException {
return this.deepCopy( cached);
}
/**
* During merge, replace the existing (target) value in the entity we are merging to
* with a new (original) value from the detached entity we are merging. For immutable
* objects, or null values, it is safe to simply return the first parameter. For
* mutable objects, it is safe to return a copy of the first parameter. For objects
* with component values, it might make sense to recursively replace component values.
*
* @param original the value from the detached entity being merged
* @param target the value in the managed entity
* @return the value to be merged
*/
@Override
public Object replace(Object original, Object target, Object owner) throws HibernateException {
return original;
}
}
이제 남은 것은 엔티티에 주석을다는 것입니다. 엔티티의 클래스 선언에 다음과 같이 입력하십시오.
@TypeDefs( {@TypeDef( name= "StringJsonObject", typeClass = StringJsonUserType.class)})
그런 다음 속성에 주석을 추가합니다.
@Type(type = "StringJsonObject")
public String getBar() {
return bar;
}
Hibernate는 json 유형으로 열을 생성하고 앞뒤로 매핑을 처리합니다. 고급 매핑을 위해 사용자 유형 구현에 추가 라이브러리를 삽입합니다.
누구나 가지고 놀고 싶은 경우 다음은 간단한 샘플 GitHub 프로젝트입니다.
이것은 매우 일반적인 질문이므로 JPA 및 Hibernate를 사용할 때 JSON 열 유형을 매핑하는 가장 좋은 방법에 대한 매우 자세한 기사 를 작성하기로 결정했습니다 .
가장 먼저해야 할 일은 프로젝트 구성 파일 에 다음과 같은 Hibernate Types Maven 종속성 을 설정하는 것입니다 pom.xml.
<dependency>
<groupId>com.vladmihalcea</groupId>
<artifactId>hibernate-types-52</artifactId>
<version>${hibernate-types.version}</version>
</dependency>
이제 PostgreSQL을 사용하는 경우 다음과 JsonBinaryType같이 클래스 수준 또는 package-info.java 패키지 수준 설명자 에서을 선언해야합니다 .
@TypeDef(name = "jsonb", typeClass = JsonBinaryType.class)
그리고 엔티티 매핑은 다음과 같습니다.
@Type(type = "jsonb")
@Column(columnDefinition = "json")
private Location location;
나중에 최대 절전 모드 5를 사용하거나하는 경우, 그 JSON유형입니다 에 의해 자동으로 등록Postgre92Dialect .
그렇지 않으면 직접 등록해야합니다.
public class PostgreSQLDialect extends PostgreSQL91Dialect {
public PostgreSQL92Dialect() {
super();
this.registerColumnType( Types.JAVA_OBJECT, "json" );
}
}
MySQL의 경우이 문서 에서 .NET Framework를 사용하여 JSON 객체를 매핑하는 방법을 확인할 수 있습니다 JsonStringType.
누군가 관심이 있다면 Hibernate에서 JPA 2.1 @Convert/ @Converter기능을 사용할 수 있습니다 . 그래도 pgjdbc-ng JDBC 드라이버 를 사용해야합니다 . 이렇게하면 필드 당 독점 확장, 방언 및 사용자 지정 유형을 사용할 필요가 없습니다.
@javax.persistence.Converter
public static class MyCustomConverter implements AttributeConverter<MuCustomClass, String> {
@Override
@NotNull
public String convertToDatabaseColumn(@NotNull MuCustomClass myCustomObject) {
...
}
@Override
@NotNull
public MuCustomClass convertToEntityAttribute(@NotNull String databaseDataAsJSONString) {
...
}
}
...
@Convert(converter = MyCustomConverter.class)
private MyCustomClass attribute;
Entity 클래스가 있지만 프로젝션에서 json 필드를 검색하는 네이티브 쿼리 (EntityManager를 통해)를 실행할 때 Postgres (javax.persistence.PersistenceException : org.hibernate.MappingException : No Dialect mapping for JDBC type : 1111)와 비슷한 문제가있었습니다. TypeDefs로 주석이 추가되었습니다. HQL로 번역 된 동일한 쿼리가 문제없이 실행되었습니다. 이 문제를 해결하려면 다음과 같이 JsonPostgreSQLDialect를 수정해야합니다.
public class JsonPostgreSQLDialect extends PostgreSQL9Dialect {
public JsonPostgreSQLDialect() {
super();
this.registerColumnType(Types.JAVA_OBJECT, "json");
this.registerHibernateType(Types.OTHER, "myCustomType.StringJsonUserType");
}
여기서 myCustomType.StringJsonUserType은 json 유형을 구현하는 클래스의 클래스 이름입니다 (위에서 Tim Fulmer 답변).
나는 인터넷에서 찾은 많은 방법을 시도했지만 대부분이 작동하지 않으며 일부는 너무 복잡합니다. 아래는 저에게 효과적이며 PostgreSQL 유형 유효성 검사에 대한 엄격한 요구 사항이 없다면 훨씬 더 간단합니다.
PostgreSQL jdbc 문자열 유형을 지정되지 않은 것으로 만듭니다.
<connection-url>
jdbc:postgresql://localhost:test?stringtype=unspecified
</connection-url>
다음을 사용하여 함수를 생성하지 않고이를 수행하기가 더 쉽습니다. WITH INOUT
CREATE TABLE jsontext(x json);
INSERT INTO jsontext VALUES ($${"a":1}$$::text);
ERROR: column "x" is of type json but expression is of type text
LINE 1: INSERT INTO jsontext VALUES ($${"a":1}$$::text);
CREATE CAST (text AS json)
WITH INOUT
AS ASSIGNMENT;
INSERT INTO jsontext VALUES ($${"a":1}$$::text);
INSERT 0 1
나는 이것을 실행하고 있었고 연결 문자열을 통해 물건을 활성화하고 암시 적 변환을 허용하고 싶지 않았습니다. 처음에는 @Type을 사용하려고했지만 사용자 지정 변환기를 사용하여 JSON과 맵을 직렬화 / 역 직렬화하기 때문에 @Type 주석을 적용 할 수 없습니다. 내 @Column 주석에 columnDefinition = "json"을 지정하기 만하면됩니다.
@Convert(converter = HashMapConverter.class)
@Column(name = "extra_fields", columnDefinition = "json")
private Map<String, String> extraFields;