Versions Compared

Old Version 14

changes.mady.by.user Hannah

Saved on

compared with

New Version Current

changes.mady.by.user Hannah

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ICE 내부 특정 NodeType에 대한 쿼리를 실행하기 위한 API 유형으로, 다음과 같은 추가적인 항목을 정의한다.

...

Expand
title"useCacheKey": falsetrue
Code Block
{
  "typeId": "api",
  "category": "snack",
  "apiId": "list",
  "apiName": "snack List",
  "apiType": "service",
  "method": "GET",
  "parameters": [
  ],
  "statistic": true,
  "aggregation": false,
  "root": {
    "configId": "root",
    "tid": "snack",
    "type": "query",
    "cacheable": true,
    "cacheTime": 60,
    "customResponse": "sampleResponse",
    "query": [
      {
        "method": "matchingShould",
        "field": "id",
        "value": "{{:id}}"
      },
      {
        "method": "matchingShould",
        "field": "name",
        "value": "{{:name}}"
      }
    ],
    "response": [
      {
        "field": "_all_",
        "type": "all"
      }
    ]
  }

{{protocol}}://{{hostname}}:{{port}}/svc/snack/list?_siteId=bestshop&id=104&name=오레오

cacheKey api::snack>list?&id.matchingShould=104&name.matchingShould=오레오

Code Block
{
    "result": "200",
    "resultMessage": "SUCCESS",
    "totalCount": 2,
    "totalTypeCount": 20,
    "resultCount": 2,
    "items": [
        {
            "id": "104",
            "label": "쿠크다스",
            "name": "쿠크다스",
            "idx": 1
        },
        {
            "id": "103",
            "label": "오레오",
            "name": "오레오",
            "idx": 2
        }
    ]
}

Expand
title"useCacheKey": truefalse
Code Block
{
  "typeId": "api",
  "category": "snack",
  "apiId": "list",
  "apiName": "snack List",
  "apiType": "service",
  "method": "GET",
  "parameters": [
  ],
  "statistic": true,
  "aggregation": false,
  "root": {
    "configId": "root",
    "tid": "snack",
    "type": "query",
    "cacheable": true,
    "cacheTime": 60,
    "customResponse": "sampleResponse",
    "query": [
      {
        "method": "matchingShould",
        "field": "id",
        "value": "{{:id}}",
        "useCacheKey": false
      },
      {
        "method": "matchingShould",
        "field": "name",
        "value": "{{:name}}"
      }
    ],
    "response": [
      {
        "field": "_all_",
        "type": "all"
      }
    ]
  }
}

{{protocol}}://{{hostname}}:{{port}}/svc/snack/list?_siteId=bestshop&id=104&name=오레오{{protocol}}://{{hostname}}:{{port}}/svc/snack/list?_siteId=bestshop&id=105&name=오레오

cacheKey api::snack>list?&name.matchingShould=오레오

cacheKey에서 id 제외

[ id=104, name=오레오 ] 로 검색 후 cacheKey에 60초간 캐싱

이후 [ id=105, name=오레오 ] 로 검색하더라도 60초간 응답결과는 변화가 없다.

Code Block
{
    "result": "200",
    "resultMessage": "SUCCESS",
    "totalCount": 2,
    "totalTypeCount": 20,
    "resultCount": 2,
    "items": [
        {
            "id": "104",
            "label": "쿠크다스",
            "name": "쿠크다스",
            "idx": 1
        },
        {
            "id": "103",
            "label": "오레오",
            "name": "오레오",
            "idx": 2
        }
    ]
}

...

커스텀 처리가 필요한 경우 해당 서비스 정의를 해야한다.

아래는 상품 통합 검색 API에 customFilter를 추가하는 사례이다.

  • Class 추가

    • location : net/ion/ice/core/query/filter

    • implements QueryFilter 하는 class 를 하나 생성한다.

  • @Component 어노테이션 추가

    • @Component("productSearchFilter")

  • custom 질의 작성

    • createQuery안에 Lucene에서 제공하는 쿼리로 직접 질의를 작성할 수 있다.

Lucene Query

Code Block
@Component("sampleFilter")
public class SampleFilter implements QueryFilter{
    @Override
    public Query createQuery(QueryContext context) {
        BooleanQuery.Builder searchQueryBuilder = new BooleanQuery.Builder();

        String searchValuetags = context.getDataStringValue("searchValuetags");

       String reSearchValue = context.getDataStringValueif ("reSearchValue"); //결과 내 재검색

        if ("".equals(searchValue".equals(tags)) {
            return null;
        }
        BooleanQuery.Builder searchValueQueryBuilder = if (!"".equals(searchValue)) {new BooleanQuery.Builder();
        try  {
  BooleanQuery.Builder searchValueQueryBuilder = getSearchValueBuilder(searchValue);       Query tagsQuery = LuceneQueryUtils.createLuceneQuery(new QueryTerm(QueryTerm.QueryTermType.NODE, "tags", "code", "matching", tags, searchQueryBuilder.add(searchValueQueryBuilder.build()PropertyType.ValueType.STRING));
            searchValueQueryBuilder.add(tagsQuery, BooleanClause.Occur.MUSTSHOULD);
        } catch (IOException e) {
        }
        searchQueryBuilder.add(searchValueQueryBuilder.build(), BooleanClause.Occur.MUST);
        return searchQueryBuilder.build();
    }
}

  • apiConfig에 customFilter 세팅

    • @Component 어노테이션 명으로 작성한다.

Code Block
{
  "configId": "root",
  "tid": "siteProduct",
  "type": "query",
  "customFilter": "productSearchFilter",
}

Sample

...

languagejson

...

  • 아래 API 설명

    • apiConfig query

      • name을 wildcard로 쿼리

    • customFilter

      • tags를 matching으로 쿼리

name의 "analyzer": "simple" - like 검색을 wildcard로 할 수 있다.

tags의 "analyzer": "code" - 콤마로 tokenize 되어있으므로 쪼개진 word에 대하여 matching으로 equals 검색을 할 수 있다.

Expand
titlesample snack schema 정의 참조
Code Block
[
  {
    "typeId": "nodeType",
    "tid": "snack",
    "parentId": "test",
    "repositoryType": "node",
    "typeName": "간식",
    "standaloneIndex": false,
    "microservice": "test",
    "propertyTypes": [
      {
        "
parameter
pid": "
productId
id",
        "name": "
상품ID
ID",
        "valueType": "STRING",
        "
required
idable": true
,
}
],
   "
statistic
indexable": true,
        "
aggregation
labelable": false,
"root":
{
     "
configId
required":
"root",
true,
        "
tid
idType": "
siteProduct
",
        "
type
orderNo": 10
"query",
"resultType": "OBJECT", 
 },
"cacheable":
false,
  {
"cacheTime":
1,
     "
allowParams
pid":
false
"name",
"orderNo":
1,
     "
customResponse
name": "
productReadResponse
Name",
"query":
[
{
"valueType": "STRING",
        "
method
indexable":
"matching"
true,
        "
field
analyzer": "
id
simple",
        "
value
labelable": true,
        "required"
{{:productId}}"
: true,
        "orderNo": 20
      },
      {
        "
method
pid": "
matching
vendor",
        "
field
name": "
approvalStatus
vendor",
        "
value
valueType": "
approval
STRING",
},
  
"indexable": true,
{
"method
"analyzer": "
matching", "field": "saleStatus
code ",
        "
value
orderNo":
"selling"
30
      },
      {
        "
method
pid": "
matching
tags",
        "
field
name": "
exposure
tags",
        "
value
valueType": "
true
STRING",
},
{
"indexable": true,
        "
method
analyzer": "
matching
code",
        "
field
orderNo":
"deleted",
40
"value": "false"
}
    ]
  }
,

]

Code Block
{
    {
   "typeId": "api",
    "methodcategory": "matchingsnack",
   
    "fieldapiId": "sitesearch",
   
    "valueapiName": "{{:_siteId}}"
 snack search List",
    }"apiType": "service",
     ]"method": "GET",
    "responseparameters": [
      {
        "fieldparameter": "idname",
        "typename": "field이름",
        "valuevalueType": "STRING",
        "required": false
      },
      {
        "fieldparameter": "nametags",
        "typename": "field검색어",
        "valuevalueType": "STRING"
,
     },   "required": false
  {    }
    "field": "siteProductSaleInfo",
   ],
    "typestatistic": "field",
   true,
    "valueaggregation": ""false,
    "root": {
},       {
 "configId": "root",
      "fieldtid": "optionTypesnack",
 
      "type": "fieldquery",
 
      "valuecustomFilter": "baseProduct.productOptionInfo.optionType"sampleFilter",
      "query": [
 },       {
          "fieldmethod": "productOptionCodeswildcard",
          "typefield": "fieldname",
          "value": "baseProduct.productOptionInfo.productOptionCodes{{:name}}"
      },  }
    {  ],
      "fieldresponse": "productOptions", [
        {
 "type": "         "field": "id",
          "type": "field",
          "value": "baseProduct.productOptionInfo.productOptions"
        },
        {
          "field": "productDetailname",
          "type": "field",
          "value": "baseProduct.productDetail"
        },
        {
          "field": "imagesvendor",
          "type": "field",
          "value": ""
        },
        {
          "field": "tags",
          "type": "field",
          "value": ""
        }
      ]
    }
  }

  • name like ‘%오레오%’인 검색 결과

Code Block
{{protocol}}://{{hostname}}:{{port}}/svc/snack/search?_siteId=bestshop&name=오레오

{
    "result": "200",
    "resultMessage": "SUCCESS",
    "totalCount": 3,
    "totalTypeCount": 20,
    "resultCount": 3,
    "items": [
        {
            "id": "103",
            "name": "오레오",
            "vendor": "크래프트푸즈,동서식품",
            "tags": "초콜릿쿠키,하얀크림,샌드"
        },
        {
            "id": "119",
            "name": "오레오 민트초코",
            "vendor": "크래프트푸즈,동서식품",
            "tags": "민트초코,초코쿠키"
        },
        {
            "id": "120",
            "name": "오레오 딸기",
            "vendor": "크래프트푸즈,동서식품",
            "tags": "딸기"
        }
    ]
}

  • name like ‘%오레오%’ 이고 tags include ‘민트초코’ 인 검색 결과

Code Block
{{protocol}}://{{hostname}}:{{port}}/svc/snack/search?_siteId=bestshop&name=오레오&tags=민트초코

{
    "result": "200",
    "typeresultMessage": "SUCCESS",
    "fieldtotalCount": 1,
        "value    "totalTypeCount": 20,
    "baseProduct.images"
      },
      {
        "field": "videos",
        "type": "field",
        "value": "baseProduct.videos"
      }
    ]
  }resultCount": 1,
    "items": [
        {
            "id": "119",
            "name": "오레오 민트초코",
            "vendor": "크래프트푸즈,동서식품",
            "tags": "민트초코,초코쿠키"
        }
    ]
}