Couchbase Connect 2015에서는 N1QL을 사용하여 샘플 Couchbase 버킷의 데이터를 쿼리하는 애플리케이션 예제를 시연했습니다.
컨퍼런스를 놓치셨더라도 문제 없습니다. 이 애플리케이션을 재현하는 방법을 살펴보고 Couchbase 4.0의 몇 가지 주요 사항을 확인해 보겠습니다.
전제 조건
- Apache Maven 3
- Java 개발 키트(JDK) 1.7
- 카우치베이스 서버 4.0
- IntelliJ IDEA 14.1+, Eclipse 또는 NetBeans. 이 예제에서는 IntelliJ IDEA가 사용됩니다.
새 프로젝트 만들기
IntelliJ IDEA를 열고 새 Java 프로젝트를 생성하도록 선택하고, 요청이 있는 경우 JDK 1.7을 사용하도록 합니다. 이 가이드의 목적에 따라 프로젝트를 호출해 보겠습니다. try-cb-java.
이제 마우스 오른쪽 버튼을 클릭합니다. try-cb-java 을 선택한 다음, 프로젝트 트리에서 프레임워크 지원 추가 을 클릭하고 Maven. 이렇게 하면 pom.xml 파일을 프로젝트에 추가합니다.
Maven 설정
내부 pom.xml 파일에 프로젝트에 더 매력적인 그룹 이름을 지정하는 것부터 시작하세요:
|
1 2 3 |
<groupId>com.couchbase.example</groupId> |
그런 다음 나머지 종속성을 파일에 추가합니다. 여기에는 Spring Boot, Couchbase 클라이언트 및 Spring 보안 프레임워크가 포함됩니다.
|
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 |
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.2.3.RELEASE</version> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-tx</artifactId> </dependency> <dependency> <groupId>org.springframework.security</groupId> <artifactId>spring-security-core</artifactId> </dependency> <dependency> <groupId>com.couchbase.client</groupId> <artifactId>java-client</artifactId> <version>2.2.0-dp</version> </dependency> </dependencies> <repositories> <repository> <id>couchbase</id> <name>couchbase repo</name> <url>https://files.couchbase.com/maven2</url> <snapshots><enabled>false</enabled></snapshots> </repository> </repositories> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> |
실행 프로필 만들기
현재로서는 현재 구성된 프로필이 없기 때문에 애플리케이션을 실행하려고 하면 오류가 발생하거나 아무 일도 일어나지 않습니다.
도구 모음에서 다음을 선택합니다. 실행 -> 구성 편집 을 클릭하고 새 Maven 구성을 추가하도록 선택합니다. 이름을 원하는 대로 지정할 수 있지만 명령줄 필드에 다음을 입력하는 것이 중요합니다:
|
1 2 3 |
spring-boot:run |
이 글에서는 구성의 이름을 다음과 같이 지정하겠습니다. 스프링 부팅.
이제 IntelliJ IDEA를 개발할 준비가 되었습니다.
카우치베이스 버킷에서 인덱스 만들기
이 튜토리얼에서는 N1QL 쿼리를 사용하므로 먼저 Couchbase Server 버킷에 인덱스를 추가해야 합니다. 이 작업은 코드를 통해 쉽게 수행할 수 있지만, 이 예제에서는 바로 가기를 사용하여 Mac OS 및 Windows에 Couchbase 4+를 설치하면 자동으로 설치되는 Couchbase 쿼리(CBQ) 클라이언트를 통해 추가하겠습니다.
Mac OS의 경우 다음에서 CBQ를 실행합니다. /애플리케이션/카우치베이스 서버 앱/콘텐츠/리소스/카우치베이스 코어/빈/cbq 를 클릭하고 다음을 실행합니다:
|
1 2 3 |
CREATE PRIMARY INDEX def_primary ON `travel-sample` USING gsi; |
Windows의 경우 다음 주소에서 CBQ를 실행합니다. C:/프로그램 파일/카우치베이스/서버/bin/cbq.exe 를 클릭하고 Mac OS에서와 동일한 N1QL 명령을 실행합니다.
메인 애플리케이션 클래스 만들기
이 프로젝트의 주요 수업은 다음과 같습니다. Application.java 을 마우스 오른쪽 버튼으로 클릭하여 만들 수 있습니다. trycb 프로젝트 트리에서 패키지를 선택하고 신규 -> 자바 클래스.
클래스를 가장 기본적인 실행 가능한 상태로 만들려면 다음을 추가하세요:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
package trycb; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @SpringBootApplication @RestController @RequestMapping("/api") public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } |
다음을 선택하여 프로젝트가 오류 없이 실행되는지 확인합니다. 실행 -> '스프링 부팅' 실행 를 클릭합니다.
CORS(교차 출처 리소스 공유) 처리하기
대부분의 테스트가 로컬에서 이루어지므로 CORS가 활성화되어 있는지 확인해야 하며, 그렇지 않으면 웹 브라우저가 자바스크립트로 API 엔드포인트를 호출할 때 불만을 제기할 수 있습니다.
Application 클래스가 Filter 클래스를 구현하는지 확인하고 다음 코드를 추가합니다:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
@Override public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException { HttpServletResponse response = (HttpServletResponse) res; response.setHeader("Access-Control-Allow-Origin", "*"); response.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept"); chain.doFilter(req, res); } @Override public void init(FilterConfig filterConfig) throws ServletException {} @Override public void destroy() {} |
카우치베이스 클러스터 및 버킷 옵션 구성하기
현재로서는 기본적으로 Couchbase가 개입하지 않는 Spring Boot 애플리케이션이 있습니다. Maven을 통해 Java 클라이언트를 포함했으므로 이제 사용을 시작할 때입니다.
애플리케이션 클래스에 다음을 추가합니다:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
@Value("${hostname}") private String hostname; @Value("${bucket}") private String bucket; @Value("${password}") private String password; public @Bean Cluster cluster() { return CouchbaseCluster.create(hostname); } public @Bean Bucket bucket() { return cluster().openBucket(bucket, password); } |
저희는 아직 호스트 이름, 버킷및 비밀번호 변수를 사용할 수 있지만, Couchbase 클러스터와 특정 버킷에 연결하는 데 사용됩니다.
리소스 변수 추가
우리가 사용하고 있는 것을 보셨죠? 호스트 이름, 버킷및 비밀번호이제 설정할 차례입니다.
IntelliJ IDEA 프로젝트 트리에서 다음을 마우스 오른쪽 버튼으로 클릭합니다. src/main/resources 을 클릭하고 새로 만들기 -> 파일. 새 파일 이름을 지정합니다. application.properties 를 클릭하고 다음 줄을 추가합니다:
|
1 2 3 |
hostname=127.0.0.1 bucket=travel-sample password= |
스프링 부트가 이 문제를 해결합니다. application.properties 파일로 이동합니다. 애플리케이션 관련 속성에 대한 자세한 정보는 스프링 공식 문서.
RESTful 엔드포인트 만들기
이 애플리케이션은 API 기반이 될 것이므로 특정 엔드포인트를 만들어야 합니다:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
@RequestMapping(value="/airport/findAll", method=RequestMethod.GET) public List<Map<String, Object>> airports(@RequestParam String search) { } @RequestMapping(value="/flightPath/findAll", method=RequestMethod.GET) public List<Map<String, Object>> all(@RequestParam String from, @RequestParam String to, @RequestParam String leave) throws Exception { } @RequestMapping(value="/user/login", method=RequestMethod.GET) public Object login(@RequestParam String user, @RequestParam String password) { } @RequestMapping(value="/user/login", method=RequestMethod.POST) public Object createLogin(@RequestBody String json) { } @RequestMapping(value="/user/flights", method=RequestMethod.POST) public Object book(@RequestBody String json) { } @RequestMapping(value="/user/flights", method=RequestMethod.GET) public Object booked(@RequestParam String username) { } |
기본적으로 사용자 등록 및 로그인, 항공편 예약 및 검색, 항공편 정보 검색을 위한 엔드포인트가 제공됩니다.
이러한 엔드포인트 뒤에 있는 로직은 청결성을 위한 다른 클래스에 나타납니다.
데이터베이스 클래스 만들기
방금 Spring Boot 애플리케이션의 구동 엔드포인트를 설정했지만 이제 데이터베이스와 상호 작용하는 로직을 살펴볼 차례입니다.
이 프로젝트의 데이터베이스 클래스는 다음과 같습니다. Database.java 을 마우스 오른쪽 버튼으로 클릭하여 만들 수 있습니다. trycb 패키지를 선택하고 IntelliJ IDEA의 프로젝트 트리에서 신규 -> 자바 클래스.
다음 내용을 추가하여 클래스의 골격을 완성하세요:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
package trycb; public class Database { private Database() { } public static List<Map<String, Object>> findAllAirports(final Bucket bucket, final String params) { } public static List<Map<String, Object>> findAllFlightPaths(final Bucket bucket, String from, String to, Calendar leave) { } public static ResponseEntity<String> login(final Bucket bucket, final String username, final String password) { } public static ResponseEntity<String> createLogin(final Bucket bucket, final String username, final String password) { } private static List<Map<String, Object>> extractResultOrThrow(QueryResult result) { } } |
이제부터 사용자가 상호 작용할 가능성이 높은 순서대로 각 메서드를 완성해 보겠습니다.
새 사용자 만들기
사용자가 POST를 발행할 때 /api/user/login로 설정하면 다음 데이터베이스 함수를 호출해야 합니다:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
public static ResponseEntity<String> createLogin(final Bucket bucket, final String username, final String password) { JsonObject data = JsonObject.create() .put("type", "user") .put("name", username) .put("password", BCrypt.hashpw(password, BCrypt.gensalt())); JsonDocument doc = JsonDocument.create("user::" + username, data); try { bucket.insert(doc); JsonObject responseData = JsonObject.create() .put("success", true) .put("data", data); return new ResponseEntity<String>(responseData.toString(), HttpStatus.OK); } catch (Exception e) { JsonObject responseData = JsonObject.empty() .put("success", false) .put("failure", "There was an error creating account") .put("exception", e.getMessage()); return new ResponseEntity<String>(responseData.toString(), HttpStatus.OK); } } |
요청에 포함된 사용자 이름과 비밀번호는 JSON 객체에 추가되고 비밀번호는 Spring BCrypt 라이브러리를 사용하여 암호화됩니다. 사용자 데이터를 추적하기 위해 새 사용자는 다음과 같은 제목의 문서에 저장됩니다. user::{사용자명_여기}. 사용 bucket.insert(doc)를 호출하면 데이터를 버킷에 삽입하려고 시도합니다. 예외가 발생하지 않으면 삽입이 성공하고 응답이 반환됩니다. 예외가 발생하면 삽입에 실패하고 오류가 반환됩니다.
기존 사용자로 로그인하기
사용자가 동일한 주소로 GET을 발행할 때 /api/user/login 엔드포인트를 호출하려면 다음 데이터베이스 함수를 호출해야 합니다:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
public static ResponseEntity<String> login(final Bucket bucket, final String username, final String password) { JsonDocument doc = bucket.get("user::" + username); JsonObject responseContent; if(BCrypt.checkpw(password, doc.content().getString("password"))) { responseContent = JsonObject.create().put("success", true).put("data", doc.content()); } else { responseContent = JsonObject.empty().put("success", false).put("failure", "Bad Username or Password"); } return new ResponseEntity<String>(responseContent.toString(), HttpStatus.OK); } |
사용 bucket.get("user::" + 사용자명) 에 제공된 사용자 이름을 입력하면 Java 애플리케이션이 버킷에 문서가 있는 경우 해당 문서를 가져옵니다. Spring BCrypt 라이브러리에는 제공된 비밀번호가 저장된 암호화된 비밀번호와 일치하는지 여부를 확인할 수 있는 훌륭한 함수가 있습니다. 일치하면 성공 객체를 반환하고, 그렇지 않으면 로그인 실패 객체를 반환합니다.
N1QL 결과 추출 및 Java에서 읽을 수 있게 만들기
N1QL은 QueryResult 객체를 반환하는 것은 요청하는 프런트엔드에 데이터를 반환하는 경우 바람직하지 않을 수 있습니다. 우리가 정말로 하고 싶은 것은 이 데이터를 목록 객체입니다.
|
1 2 3 4 5 6 7 8 9 10 11 12 |
private static List<Map<String, Object>> extractResultOrThrow(QueryResult result) { if (!result.finalSuccess()) { throw new DataRetrievalFailureException("Query error: " + result.errors()); } List<Map<String, Object>> content = new ArrayList<Map<String, Object>>(); for (QueryRow row : result) { content.add(row.value().toMap()); } return content; } |
이 함수는 N1QL 데이터가 반환될 때마다 호출됩니다.
모든 공항 찾기
이제 공항 검색과 관련하여 N1QL의 마법 같은 기능에 대해 알아보겠습니다.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
public static List<Map<String, Object>> findAllAirports(final Bucket bucket, final String params) { Statement query; AsPath prefix = select("airportname").from(i(bucket.name())); if (params.length() == 3) { query = prefix.where(x("faa").eq(s(params.toUpperCase()))); } else if (params.length() == 4 && (params.equals(params.toUpperCase()) || params.equals(params.toLowerCase()))) { query = prefix.where(x("icao").eq(s(params.toUpperCase()))); } else { query = prefix.where(i("airportname").like(s(params + "%"))); } QueryResult result = bucket.query(Query.simple(query)); return extractResultOrThrow(result); } |
위의 코드에서 IntelliJ IDEA와 함께 Fluent API를 사용하여 N1QL 쿼리를 생성하는 것을 볼 수 있습니다. 기본적으로 원시 SQL을 보면 다음과 같이 보일 것입니다:
|
1 2 3 |
SELECT airportname FROM `travel-sample` WHERE faa = {{PARAMS}} |
위 예에서 {{PARAMS}}는 LAX 또는 이와 유사한 공항을 나타냅니다. 물론 매개변수 길이가 3인 경우입니다.
모든 항공편 노선 찾기
마지막으로 비행 경로를 찾는 방법만 남았습니다:
|
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 |
public static List<Map<String, Object>> findAllFlightPaths(final Bucket bucket, String from, String to, Calendar leave) { Statement query = select(x("faa").as("fromAirport")) .from(i(bucket.name())) .where(x("airportname").eq(s(from))) .union() .select(x("faa").as("toAirport")) .from(i(bucket.name())) .where(x("airportname").eq(s(to))); QueryResult result = bucket.query(Query.simple(query)); if (!result.finalSuccess()) { throw new DataRetrievalFailureException("Query error: " + result.errors()); } String fromAirport = null; String toAirport = null; for (QueryRow row : result) { if (row.value().containsKey("fromAirport")) { fromAirport = row.value().getString("fromAirport"); } if (row.value().containsKey("toAirport")) { toAirport = row.value().getString("toAirport"); } } Statement joinQuery = select("a.name", "s.flight", "s.utc", "r.sourceairport", "r.destinationairport", "r.equipment") .from(i(bucket.name()).as("r")) .unnest("r.schedule AS s") .join(i(bucket.name()).as("a") + " ON KEYS r.airlineid") .where(x("r.sourceairport").eq(s(fromAirport)).and(x("r.destinationairport").eq(s(toAirport))).and(x("s.day").eq(leave.get(Calendar.DAY_OF_MONTH)))) .orderBy(Sort.asc("a.name")); QueryResult otherResult = bucket.query(joinQuery); return extractResultOrThrow(otherResult); } |
이 방법에서는 두 가지 N1QL 쿼리를 수행합니다. 첫 번째는 다음과 같이 쉽게 번역할 수 있습니다:
|
1 2 3 |
SELECT faa AS fromAirport FROM `travel-sample` WHERE airportname = {{PARAMS.FROM}} UNION SELECT faa AS toAirport FROM `travel-sample` WHERE airportname = {{PARAMS.TO}} |
물론 {{PARAMS}}는 엔드포인트에 전달된 모든 것을 의미합니다. 이 문에서, 우리는 모든 에서 공항과 모든 에 공항.
두 결과 집합을 모두 가져온 후, 두 결과 집합을 반복하여 에 그리고 에서 공항이 존재하지 않으면 기본값을 NULL로 설정하여 다음 쿼리가 성공하지 못하도록 합니다.
두 번째 쿼리는 다음과 같은 원시 쿼리로 변환할 수 있습니다:
|
1 2 3 |
SELECT a.name, s.flight, s.utc, r.sourceairport, r.destinationairport, r.equipment FROM `travel-sample` AS r UNNEST r.schedule AS s JOIN `travel-sample` AS a ON KEYS r.airlineid WHERE r.sourceairport = {{TO}} AND r.destinationairport = {{TO}} AND s.day = 3 ORDER BY a.name ASC |
JSON 문서에서 중첩을 해제하고 이제 평평한 키에 결합하여 항공편에 대한 일정 정보를 가져오고 있습니다.
애플리케이션 및 데이터베이스 클래스 마무리
이제 엔드포인트와 데이터베이스 메서드가 있지만 서로 연결되어 있지 않습니다. 이제 Application.java 클래스를 열고 이전에 만든 함수에 몇 가지 코드를 추가합니다:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
@RequestMapping(value="/user/login", method= RequestMethod.GET) public Object login(@RequestParam String user, @RequestParam String password) { return Database.login(bucket(), user, password); } @RequestMapping(value="/user/login", method=RequestMethod.POST) public Object createLogin(@RequestBody String json) { JsonObject jsonData = JsonObject.fromJson(json); return Database.createLogin(bucket(), jsonData.getString("user"), jsonData.getString("password")); } |
두 개의 정적 데이터베이스 메서드는 사용자 계정과 관련된 각 엔드포인트에서 호출됩니다. 이전에 만든 다른 엔드포인트에 대해서도 동일한 프로세스를 수행할 수 있습니다:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
@RequestMapping("/airport/findAll") public List<Map<String, Object>> airports(@RequestParam String search) { return Database.findAllAirports(bucket(), search); } @RequestMapping("/flightPath/findAll") public List<Map<String, Object>> all(@RequestParam String from, @RequestParam String to, @RequestParam String leave) throws Exception { Calendar calendar = Calendar.getInstance(Locale.US); calendar.setTime(DateFormat.getDateInstance(DateFormat.SHORT, Locale.US).parse(leave)); return Database.findAllFlightPaths(bucket(), from, to, calendar); } |
샘플 엔드포인트 테스트
애플리케이션의 엔드포인트를 테스트하는 방법에는 몇 가지가 있습니다. 이 예에서는 cURL을 사용하지만 Google Chrome용 Postman 또는 이와 유사한 것을 사용할 수도 있습니다.
cURL을 설치한 상태에서 터미널 또는 명령 프롬프트를 열고 다음을 입력합니다:
|
1 2 3 |
curl -X GET 'https://localhost:8080/api/airport/findAll?search=LAX' |
위의 cURL 명령은 api/에어포트/findAll 엔드포인트의 매개변수를 전달하고 검색=LAX. 성공하면 다음과 같은 응답을 받아야 합니다:
|
1 |
[{"airportname":"Los Angeles Intl"}] |
다른 모든 엔드포인트에 대해서도 동일한 종류의 테스트를 수행할 수 있습니다.
결론
방금 카우치베이스 서버와 Java용 스프링 부트를 사용하는 샘플 여행 애플리케이션을 설정하는 방법을 살펴보았습니다. 프런트엔드를 설정하지는 않았지만 AngularJS, jQuery 또는 ReactJS와 같은 언어를 사용하여 프런트엔드를 추가하는 것은 매우 가능합니다.
이 전체 프로젝트와 AngularJS 프런트엔드는 다음에서 얻을 수 있습니다. 카우치베이스 랩 깃허브 채널.