퍼스널 컴퓨팅

드롭위저드 REST API 프레임워크, 예제로 간단히 시작해보기

Matthew Tyson | InfoWorld

2021.12.27

드롭위저드(Dropwizard)는 여러 자바 패키지를 하나로 묶는 REST 지향 프레임워크다. 스프링(Spring), 그리고 스프링의 웹MVC 패키지의 대안으로, 더 매끄러운 경험을 제공한다. 스프링보다 더 많은 규칙 구성을 채택하며 REST API 제공 무관한 API 표면의 대부분을 없앤다는 점이 특징이다.

새로운 드롭위저드 프로젝트 시작하기

공식 드롭위저드 메이븐(Maven) 아키타입을 통해 새 프로젝트를 설계하는 것부터 시작한다. 로컬 시스템의 원하는 위치에서 명령줄을 열고 예시 1의 명령을 입력한다.

예시 1. 아키타입 실행

mvn archetype:generate -DarchetypeGroupId=io.dropwizard.archetypes -DarchetypeArtifactId=java-simple -DarchetypeVersion=2.0.0

이 명령어는 인터랙티브 모드로 실행된다. 여기서는 com.infoworld의 그룹 ID와 Demo의 아티팩트 ID를 사용했다. 또한 이름으로 Demo를 사용했다.

아키타입 배포가 완료되면 cd 명령어로 디렉터리로 이동한다(여기서는 cd Demo). 이제 mvn clean package를 사용해서 종속 항목을 설치한다.

다음과 같이 앱을 실행할 수 있다.

java -jar target/Demo-1.0-SNAPSHOT.jar server

(앱 이름이 Demo가 아닌 경우 자신이 지정한 이름을 사용해야 한다.)

지금 localhost:8080을 방문하면 기본 JSON 형식의 “not found” 오류가 표시된다.

{"code":404,"message":"HTTP 404 Not Found"}

엔드포인트 매핑

엔드포인트가 매핑되지 않았으므로 지금까지 앱은 404만 반환한다. 드롭위저드에서 이 부분을 수행하는 방법을 명확히 이해하는 것이 좋다. 간단한 문자열 엔드포인트를 매핑함으로써 이 프로세스를 격리한다.

단계 1에서는 경로 처리기 역할을 하는 클래스를 만든다. 드롭위저드의 주된 역할은 각 부문별로 최선의 라이브러리를 모아 사용하기 쉬운 하나의 패키지로 통합하는 것임을 기억하라. 드롭위저드는 지원되는 RESTful 엔드포인트에 대해 저지(Jersey)를 사용한다. 앱에는 이미 저지가 설정돼 있다. 경로 매핑은 저지 구문을 통해 실행된다.

단계 2에서는 앱에 처리기 클래스를 등록한다. 이 두 단계를 차례로 살펴보자.

경로 처리기 클래스 만들기

보통 드롭위저드 엔드포인트 처리기는 /src/main/java/com/infoworld/resources 폴더에 위치한다(또는 자신이 선택한 그룹 ID). 여기서는 작곡자 목록을 반환하기 위한 엔드포인트 처리기를 추가한다. 예시 2에서 볼 수 있듯이 최고의 작곡가만 반환한다. /resources 디렉터리에 새 SongWriters.java 파일을 만든다.

예시 2. SongWriters 엔드포인트

package com.infoworld.resources;

import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import java.util.List;
import java.util.Optional;

@Path("/songwriters")
@Produces(MediaType.APPLICATION_JSON)
public class SongWriters {
public SongWriters() {
}

@GET
public String getBrands() {
return "{'name':'Roger Waters','name':'Tom Petty'}";
}
}

예시 2는 간단하다. 클래스 자체에 @Path 주석을 통해 경로가 부여됐고 @Produces 주석을 통해 JSON이 미디어 형식으로 지정됐다. 그 다음 문자열을 반환하는 getBrands() 메서드가 @GET 주석을 통해 GET HTTP 메서드에 매핑된다. 이 메서드는 작곡자 모음을 나타내는 하드코딩된 문자열을 반환한다.

처리기 등록

이제 처리기를 등록할 차례다. /src/main/java/com/infoworld/DemoApplication.java 파일을 열고 run() 메서드를 예시 3과 같이 수정한다.

예시 3. SongWriters 처리기 등록

import com.infoworld.resources.SongWriters;
// ...
public void run(final DemoConfiguration configuration, final Environment environment) {
SongWriters songWriters = new SongWriters();
environment.jersey().register(songWriters);
}

이 부분 역시 간단하다. 목록 3에서는 조금전에 만든 클래스를 가져온 다음 Environment 객체를 사용해서 저지에 액세스해 처리기를 등록한다. run 메서드는 DemoConfiguration 객체도 받는데, 이 객체의 동작에 대해서는 잠시 후에 살펴본다.

처리기 테스트

이제 localhost:8080/songwriters를 방문하면 하드코딩한 JSON이 반환된다. 이 시스템이 문자열을 JSON으로 반환하는 작업을 매끄럽게 처리한 것을 알 수 있다.

도메인 모델링

이제 하드코딩된 문자열에서 실제 도메인 객체를 사용하는 것으로 바꿔보자. 먼저 /src/main/java/com/infoworld/domain/SongWriter.java 파일을 만들고 내용을 예시 4의 코드로 채워넣는다.

예시 4. SongWriter 도메인 모델 클래스

package com.infoworld.domain;

import java.util.ArrayList;
import java.util.List;

public class SongWriter {
private final String name;
private List songs = new ArrayList<>();

public SongWriter(final String name, final List songs) {
this.name = name;
this.songs = songs;
}

public String getName() {
return name;
}

public List getSongs(){
return this.songs;
}
}

리포지토리 클래스 추가

이제 데이터 액세스 계층을 나타내기 위한 리포지토리 클래스를 추가한다. /src/main/java/com/infoworld/repo/SongWriterRepo.java라는 새 폴더와 파일을 만든다.

예시 5. SongWriterRepo 클래스

package com.infoworld.repo;

import com.infoworld.domain.SongWriter;
import java.util.List;
import java.util.ArrayList;
import java.util.Optional;
import java.util.stream.Collectors;

public class SongWriterRepo {
private final List songWriters;
public SongWriterRepo(){
this.songWriters = new ArrayList();
}

public SongWriterRepo(List songWriters){
this.songWriters = songWriters;
}

public List findAll(){
return songWriters;
}

public Optional getByName(final String name){
return songWriters.stream().filter(sw -> sw.getName().equals(name)).findFirst();
}
}

예시 5에서 볼 수 있듯이 SongWriterRepo는 findAll() 메서드를 통해 List의 모든 SongWriter 객체를 반환하며 getByName() 메서드는 전달된 문자열 이름에 의해 지정된 작곡자를 가져온다.

도메인 계층 사용

새 계층을 사용해서 리소스 엔드포인트에 의해 반환되는 JSON을 구동한다. com.infoworld.resource.SongWriter를 예시 6과 같이 수정한다.

예시 6. 수정된 SongWriters 클래스

package com.infoworld.resources;

import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import java.util.List;
import java.util.Optional;

import com.infoworld.repo.SongWriterRepo;
import com.infoworld.domain.SongWriter;

@Path("/songwriters")
@Produces(MediaType.APPLICATION_JSON)
public class SongWriters {
private final SongWriterRepo repo;
public SongWriters(SongWriterRepo repo) {
this.repo = repo;
}

@GET
public List getBrands() {
return repo.findAll();
}
}

예시 6은 하드코딩된 문자열을 없애고 그 대신 생성자에 설정된 SongWriterRepo 클래스를 참조한다. 이제 예시 7을 보면 DemoApplication 클래스에서 이러한 여러 클래스가 함께 연결된다.

예시 7. DemoApplication에서 도메인 클래스 연결하기

package com.infoworld;

import io.dropwizard.Application;
import io.dropwizard.setup.Bootstrap;
import io.dropwizard.setup.Environment;

import com.infoworld.resources.SongWriters;
import com.infoworld.repo.SongWriterRepo;

public class DemoApplication extends Application {
// ...
@Override
public void run(final DemoConfiguration configuration, final Environment environment) {
SongWriterRepo swRepo = new SongWriterRepo();
SongWriters songWriters = new SongWriters(swRepo);
environment.jersey().register(songWriters);
}
}

DemoApplication 클래스로 돌아가서 예시 7과 같이 수정한다. SongWriterRepo 객체를 인스턴스화하고 SongWriters 리소스 객체를 매개변수화한 다음에 저지로 보내는 것을 볼 수 있다.

프로젝트를 다시 빌드하고 localhost:8080/songwriters를 방문하면 빈 문자열이 표시된다. 예시 8과 같이 하드코딩된 작곡자 이름을 추가해 보자.

예시 8. 작곡자 추가

public void run(final DW2Configuration configuration,
final Environment environment) {

List preload = new ArrayList();
preload.add(new SongWriter("Mark Knopfler", new ArrayList()));

SongWriterRepo swRepo = new SongWriterRepo(preload);
SongWriters songWriters = new SongWriters(swRepo);
environment.jersey().register(songWriters);
}

이제 엔드포인트에서 결과를 받게 된다.

구성 파일 사용

src/main/resources/Demo-Config.yml에 새 구성 파일을 추가하고 예시 9의 내용을 집어넣는다.

예시 9. 구성 YAML

---
songWriters:
- John Lennon
- Jeff Lynne

com.infoworld.DemoConfiguration.java 파일을 예시 10과 같이 수정한다. 이 파일은 잭슨(Jackson)을 통해 구성 파일을 모델링하는 데 사용된다.

목록 10. 구성 자바

package com.infoworld;

import io.dropwizard.Configuration;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.hibernate.validator.constraints.*;
import javax.validation.constraints.*;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.List;
import java.util.ArrayList;

public class DW2Configuration extends Configuration {
private List<String> songWriters;
@JsonCreator
public DW2Configuration(@JsonProperty("songWriters") List<String> songWriters){
this.songWriters = songWriters;
}
public List<String> getSongWriters(){
return this.songWriters;
}
}

예시 11과 같이 DemoApplication에서 파일을 사용한다.

예시 11. 구성 파일을 사용하여 DemoApplication.java에 작곡자 사전 로드

@Override
public void run(final DemoConfiguration configuration,
final Environment environment) {

List preload = new ArrayList();

configuration.getSongWriters().forEach(sw -> preload.add(new SongWriter(sw, new ArrayList())));
SongWriterRepo swRepo = new SongWriterRepo(preload);
SongWriters songWriters = new SongWriters(swRepo);
environment.jersey().register(songWriters);
}

예시 11에서 변경의 핵심은 구성 파일이 DemoConfiguration 클래스에 포함되어 리포지토리 클래스를 사전에 로드하는 데 사용되는 getSongWriters() 메서드를 채운다는 것이다.

구성 파일을 사용해 앱 실행

구성 파일로 이 앱을 실행하려면 약간의 변경이 필요하다. 예시 12에서 server 호출 후 파일이 참조되는 것을 볼 수 있다.

예시 12. 구성 파일로 앱 실행

java -jar target/DW2-1.0-SNAPSHOT.jar server src/main/resources/DW2-config.yml

이제 localhost:8080/songwriters로 앱을 방문하면 사전에 로드된 작곡자를 볼 수 있다.

드롭위저드는 스프링 기반 RESTful API의 가벼운 대안이다. 이 기사에서 봤듯이 드롭위저드는 이와 같은 필요에 대응하는 단순하지만 충분한 스택을 제공하는 데 초점을 둔다.

데모 앱 소스는 여기에서 받을 수 있다. editor@itworld.co.kr

Tags REST API Java 드롭위저드

함께 보면 좋은 콘텐츠

'코드 1줄로 지도 만들기' R에서 맵뷰를 사용하는 방법

윈도우 서버 2022 대표 기능 총정리

IDG 블로그 | 클라우드 아키텍처에서 기술 편견의 영향

"쿠버네티스 보급률 증가, 서버리스는 소폭 하락"…클라우드 네이티브 컴퓨팅 재단 연구

Surfshark

“유료 VPN, 분명한 가치 있다” VPN 선택 가이드

ⓒ Surfshark VPN(가상 사설 네트워크, Virtual Private Network)은 인터넷 사용자에게 개인 정보 보호와 보안을 제공하는 중요한 도구로 널리 인정받고 있다. VPN은 공공 와이파이 환경에서도 데이터를 안전하게 전송할 수 있고, 개인 정보를 보호하는 데 도움을 준다. VPN 서비스의 수요가 증가하는 것도 같은 이유에서다. 동시에 유료와 무료 중 어떤 VPN을 선택해야 할지 많은 관심을 가지고 살펴보는 사용자가 많다. 가장 먼저 사용자의 관심을 끄는 것은 별도의 예산 부담이 없는 무료 VPN이지만, 그만큼의 한계도 있다. 무료 VPN, 정말 괜찮을까? 무료 VPN 서비스는 편리하고 경제적 부담도 없지만 고려할 점이 아예 없는 것은 아니다. 보안 우려 대부분의 무료 VPN 서비스는 유료 서비스에 비해 보안 수준이 낮을 수 있다. 일부 무료 VPN은 사용자 데이터를 수집해 광고주나 서드파티 업체에 판매하는 경우도 있다. 이러한 상황에서 개인 정보가 유출될 우려가 있다. 속도와 대역폭 제한 무료 VPN 서비스는 종종 속도와 대역폭에 제한을 생긴다. 따라서 사용자는 느린 인터넷 속도를 경험할 수 있으며, 높은 대역폭이 필요한 작업을 수행하는 데 제약을 받을 수 있다. 서비스 제한 무료 VPN 서비스는 종종 서버 위치가 적거나 특정 서비스 또는 웹사이트에 액세스하지 못하는 경우가 생긴다. 또한 사용자 수가 늘어나 서버 부하가 증가하면 서비스의 안정성이 저하될 수 있다. 광고 및 추적 위험 일부 무료 VPN은 광고를 삽입하거나 사용자의 온라인 활동을 추적하여 광고주에게 판매할 수 있다. 이 경우 사용자가 광고를 보아야 하거나 개인 정보를 노출해야 할 수도 있다. 제한된 기능 무료 VPN은 유료 버전에 비해 기능이 제한될 수 있다. 예를 들어, 특정 프로토콜이나 고급 보안 기능을 지원하지 않는 경우가 그렇다. 유료 VPN의 필요성 최근 유행하는 로맨스 스캠은 인터넷 사기의 일종으로, 온라인 데이트나 소셜 미디어를 통해 가짜 프로필을 만들어 상대를 속이는 행위다. 이러한 상황에서 VPN은 사용자가 안전한 연결을 유지하고 사기 행위를 방지하는 데 도움이 된다. VPN을 통해 사용자는 상대방의 신원을 확인하고 의심스러운 활동을 감지할 수 있다. 서프샤크 VPN은 구독 요금제 가입 후 7일간의 무료 체험을 제공하고 있다. ⓒ Surfshark 그 외에도 유료 VPN만의 강점을 적극 이용해야 하는 이유는 다음 3가지로 요약할 수 있다. 보안 강화 해외 여행객이 증가함에 따라 공공 와이파이를 사용하는 경우가 늘어나고 있다. 그러나 공공 와이파이는 보안이 취약해 개인 정보를 노출할 위험이 있다. 따라서 VPN을 사용하여 데이터를 암호화하고 개인 정보를 보호하는 것이 중요하다. 서프샤크 VPN은 사용자의 개인 정보를 안전하게 유지하고 해킹을 방지하는 데 유용하다. 개인정보 보호 인터넷 사용자의 검색 기록과 콘텐츠 소비 패턴은 플랫폼에 의해 추적될 수 있다. VPN을 사용하면 사용자의 IP 주소와 로그를 숨길 수 있으며, 개인 정보를 보호할 수 있다. 또한 VPN은 사용자의 위치를 숨기고 인터넷 활동을 익명으로 유지하는 데 도움이 된다. 지역 제한 해제 해외 여행 중에도 한국에서 송금이 필요한 경우가 생길 수 있다. 그러나 IP가 해외 주소이므로 은행 앱에 접근하는 것이 제한될 수 있다. VPN을 사용하면 지역 제한을 해제해 해외에서도 한국 인터넷 서비스를 이용할 수 있다. 따라서 해외에서도 안전하고 편리하게 인터넷을 이용할 수 있다. 빠르고 안전한 유료 VPN, 서프샤크 VPN ⓒ Surfshark 뛰어난 보안 서프샤크 VPN은 강력한 암호화 기술을 사용하여 사용자의 인터넷 연결을 안전하게 보호한다. 이는 사용자의 개인 정보와 데이터를 보호하고 외부 공격으로부터 사용자를 보호하는 데 도움이 된다. 다양한 서버 위치 서프샤크 VPN은 전 세계 곳곳에 여러 서버가 위치하고 있어, 사용자가 지역 제한된 콘텐츠에 액세스할 수 있다. 해외에서도 로컬 콘텐츠에 손쉽게 접근할 수 있음은 물론이다. 속도와 대역폭 서프샤크 VPN은 빠른 속도와 무제한 대역폭을 제공하여 사용자가 원활한 인터넷 경험을 누릴 수 있도록 지원한다. 온라인 게임, 스트리밍, 다운로드 등 대역폭이 필요한 활동에 이상적이다. 다양한 플랫폼 지원 서프샤크 VPN은 다양한 플랫폼 및 디바이스에서 사용할 수 있다. 윈도우, 맥OS, iOS, 안드로이드 등 다양한 운영체제 및 디바이스에서 호환되어 사용자가 어디서나 안전한 인터넷을 즐길 수 있다. 디바이스 무제한 연결 서프샤크 VPN은 무제한 연결을 제공하여 사용자가 필요할 때 언제든지 디바이스의 갯수에 상관없이 VPN을 사용할 수 있다.

평점 - 댓글 -개

평점