Hibernate Search

-
Spring Boot + JPA + Hibernate를 사용해 서버를 구성하였다.
search 기능이 필요해 Hibernate Search를 넣었는데 사용법은 아래와 같다.

Step)
1. pom.xml에 hibernate-search-orm 추가.
2. Entity 추가.
3. ②번의 entity searching을 위한 custom repository interface 추가.
4. ②번의 JpaRepository를 만들고 ④번 repository extends.
5. ③번의 repository searching interface implement.
6. ⑤에서 사용할 NameFilterFactory 추가.

1. pom.xml에 hibernate search 추가

 1
 2
 3
 4
 5
 6
 7

<!-- Hibernate Search -->
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-search-orm</artifactId>
    <version>5.11.1.Final</version>
</dependency>

2. MyEntity Entity 생성

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@Indexed
@Entity
@Table(name = "my_entity")
@Getter
@AnalyzerDef(
        name = "emailAnalyzer",
        tokenizer = @TokenizerDef(factory = ClassicTokenizerFactory.class),
        filters = {
                @TokenFilterDef(factory = LowerCaseFilterFactory.class)
        }
)
@FullTextFilterDef(name = "NameFilterFactory", impl = NameFilterFactory.class)
public class MyEntity {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "card_id")
    @SortableField
    private Long id;

    @Column(name = "name")
    @Setter
    @Field
    @SortableField
    private String name;

    @Column(name = "email")
    @Setter
    @Field
    @Analyzer(definition = "emailAnalyzer")
    @SortableField
    private String email;

    @Column(name = "phone")
    @Setter
    @Field
    @SortableField
    private String phone;

    public MyEntity(String name,
                    String email,
                    String phone) {
        this.name = name;
        this.email = email;
        this.phone = phone;
    }
}
설명)
  • @Indexed로 searching 할 entity 추가.
  • @Field로 searching 대상이 될 field 추가.
  • @SortableField로 sort 대상이 될 field 추가.
  • AnalyzerDef로 email searching을 위한 analyzer 추가.
  • FullTextFilterDef로 searching 결과 filtering 할 filter factory 추가.

3. Searching을 위한 Custom Repository 생성

1
2
3
public interface MyEntitySearchRepository {
    List<MyEntity> searchKeyword(String name, String keyword, Pageable pageable);
}

설명)
  • name은 filtering할 대상.
  • keyword는 searching keyword.
  • pageable은 spring에서 paging에 사용하는 Pageable 객체.

4. JpaRepository 생성

1
2
public interface MyEntityRepository extends JpaRepository<MyEntity, Long>, MyEntitySearchRepository {
}
설명)
  • JpaRepository 생성하면서 searching을 위한 interface extends.
  • Custom repository로 만든 이유는 @PersistenceContext로 EntityManager 가져오기 위해.

5. Searching Interface Implement

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
@Component(value = "myEntitySearchRepository")
public class MyEntitySearchRepositoryImpl implements MyEntitySearchRepository {
    @PersistenceContext
    private EntityManager entityManager;

    public void initializeHibernateSearch() {
        try {
            FullTextEntityManager fullTextEntityManager = Search.getFullTextEntityManager(entityManager);
            fullTextEntityManager.createIndexer().startAndWait();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

    @Override
    public List<MyEntity> searchKeyword(String name, String keyword, Pageable pageable) {
        // create lucene search index.
        initializeHibernateSearch();

        FullTextEntityManager fullTextEntityManager = Search.getFullTextEntityManager(entityManager);
        QueryBuilder qBuilder = fullTextEntityManager.getSearchFactory()
                .buildQueryBuilder()
                .forEntity(MyEntity.class)
                .get();

        // Lucene query by Hibernate DSL
        Query luceneQuery = qBuilder
                .keyword()
                .wildcard()
                .onFields("email", "phone")
                .matching(keyword)
                .createQuery();

        FullTextQuery fullTextQuery = fullTextEntityManager.createFullTextQuery(luceneQuery, MyEntity.class);

        // Search filter by name
        fullTextQuery.enableFullTextFilter("NameFilterFactory").setParameter("name", name);

        // pagination
        // convert to start element
        int page = pageable.getPageNumber() * pageable.getPageSize();
        int size = pageable.getPageSize();
        fullTextQuery.setFirstResult(page);
        fullTextQuery.setMaxResults(size);

        // Sort
        if (!pageable.getSort().isUnsorted()) {
            org.apache.lucene.search.Sort sort = new org.apache.lucene.search.Sort();
            Iterator<Sort.Order> orders = pageable.getSort().iterator();
            Sort.Order o = orders.next();
            if (o.getDirection().equals(Sort.Direction.ASC)) {
                sort.setSort(new SortField(o.getProperty(), SortField.Type.STRING, false));
            } else {
                sort.setSort(new SortField(o.getProperty(), SortField.Type.STRING, true));
            }
            fullTextQuery.setSort(sort);
        }

        // If want to get total count.
        // int total = fullTextQuery.getResultSize();

        return fullTextQuery.getResultList();
    }
}
설명)
  • initializeHibernateSearch()는 Lucene indexing을 위한 함수.
  • hibernate의 CRUD는 자동 indexing 되기 때문에 기존의 data가 있는 경우에 실행하면 됨.
  • 위 코드는 searching 할때마다 indexing이 호출 되는데 그래도 되나?
  • keyword searching하고 결과를 name으로 filtering.
  • paging과 sorting도 처리 되어 있음.

6. NameFilterFactory 생성

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
public class NameFilterFactory {
    private String name;

    public void setName(String name) {
        this.name = name;
    }

    @Factory
    public Query getFilter() {
        return new TermQuery(new Term("name", name));
    }
}
설명)
  • searching에서 filtering할 name field factory.

댓글

댓글 쓰기

이 블로그의 인기 게시물

[Protocol] WIEGAND 통신

-
이미지
1. WIEGAND 통신 방식이란? 두 개의 D0, D1 라인을 이용해 소량의 데이터를 전송 하는 방식으로 , 주로 출입통제 장치의 리더와 컨트롤러 간의 통신 방식에 사용 됩니다. 물론 리더는 RS-485, RS-232, ABA-Track II 와 같이 다양한 통신 방식을 취하기도 하지만, 주로 WIEGAND 방식을 많이 사용 합니다. 그 이유는 .. 개인적으로 생각했을때 구현이 쉽고, 별도의 PHY 칩을 사용 하지 않기 때문에 생산 단가를 좀더 줄일 수 있어서가 아닌가.. 생각해 봅니다.  2. WIEGAND 통신 타이밍도 위 그림과 같이 D0, D1  두 신호선으로 통신 합니다. D0, D1 이 각각 의미 하는 것은, D0 가 LOW 이면 그 비트 값이 '0' 이고, D1 이 LOW 이면 그 비트 값이 '1' 임을 의미 합니다. 따라서 D0 와 D1 은 동시에 LOW 가 되지 않으며, 정해진 타이밍이 있습니다. 예를 들어 위 그림의 신호를 데이터로 변환해 보자면, 4 번 LOW 값이 있으므로 4 비트 임을 알 수 있고, 값은 1101 임을 알 수 있습니다. 3. WIEGAND 신호 구현 실제 WIEGAND 통신 방식으로 데이터를 전송 할때는  데이터가 손상될 수 있으므로, 앞뒤에 패리티비트를 추가 하거나, 복잡한 계산방법을 적용해 데이터를 암호화 하는 경우도  있습니다. 하지만 생성된 데이터는 약 20 ~ 40 Bit 이내의 데이터이고, 이를 0 번 비트 부터 차례대로 전송 하면 됩니다. 해당 비트가 0 이면 D0 가 연결된 PIN 을 LOW 로 하고, 비트 값이 1 이면 D1 이 연결된 PIN 을 LOW 로 해주면 그만 입니다. 물론 회로적으로 GPIO 의 출력을 그대로 내보내지는 않고 트랜지스터 등을 이용해 힘을 실어 주어야 겠지요. 그럼 받는 쪽은 어떻게 해야 할까요? 위 회로의 좌측이 리더에서 들어온 WIEGAND 신호이고, 우측...
자세한 내용 보기

Orange for Oracle에서 한글 깨짐 해결책

-
NLS_LANG 한글 깨짐 현상 접속은 잘되었는데  SQL 툴을 통하여 조회를 해 보면 한글 부분이 ?? 로 나타나는 현상이 발생하는 경우가 있습니다.  Oracle Server 에서 사용하는 언어와 Orange for Oracle 에서 사용하는 언어가 달라서 발생하는 경우입니다.  이 경우 SQL TOOL 에서  SELECT * FROM v$NLS_PARAMETERS 를 입력하면  NLS_LANGUAGE,  NLS_TERRITORY, NLS_CAHRACTERSET 세가지 값을 알 수 있습니다. Orange -> Tools -> Orange Options -> Common -> Environment -> Client -> NLS_LANG 의 위치에  입력을 하고 저장을 하면됩니다.  제 경우에는 AMEFICAN_AMERICA.KO16KSC5601 로 설정이 되었습니다.  여기까지 실행하면 Orange for Oracle을 정상적으로 사용할 수 있게 됩니다.  출처:  https://gostart.tistory.com/71  [Ogam]
자세한 내용 보기

[URL] 대소문자를 구분하나?

-
URL 샘플 http://www.example.com/mypage?param=1 1. http는 프로토콜 2. www.example.com은 도메인 네임(DNS) 3. mypage는 resource 위치 4. param=1은 query parameter Conclusion 1은 대소문자 상관없고, 2도 DNS 서버가 대소문자 구분하지 않으므로 상관 없음. 3은 운영되고 있는 서버의 특성을 탐. 윈도우의 경우는 파일명에 대소문자 구분을 하지 않으므로 상관없고, 유닉스 계열의 경우 파일명 대소문자 구분하니 대소문자 잘 맞춰 줘야함. 4는 웹 서비스의 스크립트 언어 특성에 따름. asp를 제외한 대부분의 스크립트는 대소문자를 구분하는 편이다.
자세한 내용 보기