심심해서 하는 블로그 :: 'MongoDB' 태그의 글 목록

'MongoDB'에 해당되는 글 2건

[Spring Boot]2-2. RestController with Swagger2

Spring Framework 2018. 1. 21. 15:59

전체 소스 코드 : https://github.com/ssooni/ssoonidev_blog

Spring Boot : ver 1.5.9

JAVA : ver 1.8 

Build Tool : MAVEN



1. 목표

MongoDB의 데이터를 접근하는 댓글 REST API를 만들어 보는 것이 목표입니다. 추가적으로 Redis Cache Layer를 두어 보는 것도 함께 실습해볼 예정입니다.


2. RestController

Spring 4.0부터 지원하는 @RestController Annotation은 @Controller와 @ResponseBody가 하나로 결합된 Annotation입니다. 따라서 이 클래스 내부의 모든 메서드들의 반환 값은 HTTP Response Body에 직접 쓰이게 됩니다. 따라서 View가 없는 Controller입니다.


대부분 Web 프로그램을 처음으로 개발한다 하면, JSP를 이용해서 화면을 만들다 보니, Web Service는 반드시 View가 있어야 한다고 생각하기 쉽습니다. 하지만 Web Service마다 목적이 있습니다. 사용자에게 View를 제공하는 경우도 있지만, 프로그램끼리 데이터를 주고받기 위해 개발하는 경우도 있습니다. RestController는 후자의 경우에 사용하는 Controller라고 할 수 있습니다. 


이 전 포스팅에서 구현한 ReplyService를 이용해서 RestController를 구현해 보겠습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
@RestController
public class ReplyController {
 
    private Logger logger = LoggerFactory.getLogger(ReplyController.class);
    
    @Autowired
    private ReplyService replyService;
    
    @GetMapping("/reply/{bno}")
    public List<ReplyDomain> findByBno(@PathVariable("bno") int bno) throws Exception{
        return replyService.findbyBno(bno);
    }
    // 이하 생략...
}
cs


코드 상에서도 일반 @Controller를 사용했을 때와 차이점을 알 수 있는데, ModelAndView 객체나 String으로 View의 경로를 지정하지 않고 데이터 그 자체를 반환하는 것을 알 수 있습니다. 이후에 실행한다면, 화면에 아래의 그림처럼 JSON 형태의 화면을 보여줄 것입니다. 물론 MongoDB에 데이터가 있는 경우에만 해당됩니다.



3. Swagger

View가 없다 보니 문제가 있습니다. 바로 시연이나 테스트에서 보여주기가 힘들다는 거죠. 데이터를 읽는 것은 그래도 저렇게 화면이라도 나오니까 망정이지만, 데이터를 입력하거나 삭제, 수정하는 경우에는 화면 없이 시연하기 어렵습니다. 그렇다고 이 시연을 위해 View를 새로 만든다는 것은 시간 낭비입니다.  하지만 Swagger를 이용하면 이런 점을 깔끔하게 해결할 수 있습니다. Swagger가 알아서 View를 만들어주기 때문이죠.





Swagger는 프로그램이 시작할 때, URL Mapping을 추적해서 위의 그림과 같은 View를 만들어 줍니다. 그리고 각각의 Tab에는 위의 그림처럼 입력이 가능한 Form과 각각의 타입 등의 정보를 제공해줍니다. 따라서 이 프로그램을 처음 보는 사람도 어떤 URL로 구성되어 있으며, 각각의 URL은 어떤 인자를 받아서 어떻게 반환하는지를 쉽게 확인이 가능합니다. 


pom.xml

1
2
3
4
5
6
7
8
9
10
11
<!-- Swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.7.0</version>
</dependency>
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.7.0</version>
</dependency>
cs


이제 개발에 적용하는 방법을 알아보겠습니다. 우선 swagger2와 화면을 보여줄 swagger-ui 라이브러리를 추가합니다. 그리고 Swagger를 설정하기 위한 Configuration Class를 작성합니다. 


SwaggerConfig.java

1
2
3
4
5
6
7
8
9
10
11
12
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.ant("/reply/**")) 
                .build();
    }
}
cs


line 8

컨트롤러가 있는 패키지를 지정할 수 있습니다. 만약 어떤 패키지를 특정하지 않고 모든 패키지를 추적하고 싶다면 매개변수에서 RequestHandlerSelectors.any()를 사용하면 됩니다. 


line 9

Mapping URL 중에서 어떤 URL을 사용할 것인지 정해줄 수 있습니다. 저는 /reply 밑의 모든 경로에 대하여 추적하도록 하였습니다. 마찬가지로 모든 경로를 다 추적하게 하고 싶다면 PathSelectors.any()를 매개변수로 사용하면 됩니다.


이제 Spring Boot 프로그램을 실행하여, http://localhost:8080[/root_path]/swagger-ui.html로 이동하면, 앞서 실행한 결과를 쉽게 확인할 수 있습니다. 


전체 소스코드는 GitHub를 확인해주세요.

다음 포스팅에서는 Redis로 Cache Layer를 구성하는 방법을 포스팅하겠습니다.




저작자표시

'Spring Framework' 카테고리의 다른 글

[Spring Boot]2-1.Mongo DB와 연결하기  (5) 2018.01.18
[Spring Boot]1-2. 간단한 게시판 만들기 (Modal로 깔끔하게 만들자)  (5) 2018.01.16
[Spring Boot]1-1. 간단한 게시판 만들기 (MySQL과 데이터 주고 받기)  (0) 2018.01.12
Chan Ho Son
,

[Spring Boot]2-1.Mongo DB와 연결하기

Spring Framework 2018. 1. 18. 16:23

전체 소스 코드 : https://github.com/ssooni/ssoonidev_blog

Spring Boot : ver 1.5.9

JAVA : ver 1.8 

Build Tool : MAVEN



1. 목표

MongoDB의 데이터를 접근하는 댓글 REST API를 만들어 보는 것이 목표입니다. 추가적으로 Redis Cache Layer를 두어 보는 것도 함께 실습해볼 예정입니다.


2. MongoDB

MongoDB를 처음으로 사용한 건 인턴십 때였습니다. NoSQL의 존재는 이미 알고 있었지만, 이렇게 프로젝트에서 사용은 처음으로 해봤습니다. MySQL이나 오라클을 먼저 접한 저는 테이블이 없고, 난생처음 보는 쿼리에 적응하기 조금 시간이 필요했습니다.


MongoDB vs MySQL


Mongo DB

세상의 모든 데이터가 일정한 틀과 형태를 가지고 있지는 않습니다. 대화나 채팅, 음악 등이 대표적이라 할 수 있죠. 이러한 데이터는 MySQL과 같은 테이블에 저장하기 어렵습니다. 테이블을 만들 때, 하나의 공통 거릴 찾아서 하나의 속성(Column)을 만드는 일이 어렵기 때문이죠. 


Mongo DB는 Collection 안에 Document에 데이터를 저장합니다. Document는 특별한 틀을 가지고 있지 않습니다. Document의 Field 안의 데이터 형식이 서로 안 맞아도 입력이 가능하고, 각 Document들이 모두 일관된 Field를 가지지 않아도 됩니다. 이 방법은 비정형 데이터를 저장하는데 최적의 방법이라고 생각합니다. 관심이 가는 분야이고, Spring Boot 포스팅이 다 끝나는 대로 포스팅을 해보고 싶습니다.


3. Mongo + Spring Boot

전체 폴더 구조나 소스코드는 GitHub를 참고해주세요


pom.xml 추가

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<!-- Redis Cache Layer -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
 
<!-- Swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>
<!-- Mogno DB -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>
cs


spring-boot-starter-data-mongodb

Spring Boot와 Mongo를 연결하기 위해 꼭 필요한 라이브러리입니다. 설정 및 데이터 접근을 하기위한 라이브리입니다. 


spring-boot-starter-data-redis (선택)

다음 포스팅에서 다룰 예정인 Redis Cache를 구현할 때 필요한 라이브러리입니다. 몽고DB만 사용하고 말겠다 생각하는 분이라면 굳이 추가하지 않으셔도 됩니다. 


springfox-swagger2(선택)

Swagger라는 API Document를 자동으로 생성해주는 라이브러리입니다. REST API를 사용하는 경우, 대부분 View가 없어, 테스트를 하거나 시연을 하기 힘든 부분이 있었는데 그것을 해결해준 고마운 라이브러리입니다.


application.properties 작성

1
2
3
4
5
## MongoDB Config ##
spring.data.mongodb.uri=mongodb://localhost:27017
spring.data.mongodb.database=ssooni
spring.data.mongodb.username=ssooni526
spring.data.mongodb.password=ssooni
cs


MongoDB의 uri와 기본적으로 사용할 데이터베이스, 인증을 위한 username과 password 정보를 작성해줍니다. uri에  mongodb://[username]:[password]@[hostname]:[port number]/[database] 처럼 모든 정보를 넣을 수도 있습니다.


MongoConfig.java

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
@Configuration
public class MongoConfig extends AbstractMongoConfiguration{
 
    @Value("${spring.data.mongodb.username}")
    private String userName;
    
    @Value("${spring.data.mongodb.password}")
    private String password;
    
    @Value("${spring.data.mongodb.database}")
    private String database;
    
    @Override
    protected String getDatabaseName() {
        return database;
    }
 
    @Override
    public Mongo mongo() throws Exception {
        MongoCredential credential = MongoCredential.createCredential(userName, database, password.toCharArray());
        return new MongoClient(new ServerAddress("localhost", 27017), Arrays.asList(credential));
    }
    
    public @Bean MongoTemplate mongoTemplate() throws Exception{ 
        return new MongoTemplate(mongo(), database);
    }
    
}
cs


MongoDB와 연결하여 사용하기 위해 설정을 하는 클래스입니다. @Controller나 @Service Annotation처럼 @Configuration Annotation을 사용해, 이 클래스가 무엇인가를 설정하기 위한 용도로 작성된 코드임을 컨테이너에게 알려줍니다. MongoConfig 클래스는 AbstractMongoConfiguration 클래스를 상속하여 구현합니다. 

이때 반드시 getDatabaseName()(line 14)과 mongo()(line 19) 함수를 오버라이드 해야 합니다.


line 4 ~ line 11

application.properties에 정의한 값은 @Value Annotation으로 접근 가능합니다. 


line 19 

mongo() 함수는 Mongo DB에 접근할 객체를 반환하는 함수입니다. 이 때 Mongo에 접근하기 위해 인증정보가 필요한 경우에 MongoCredential 객체에 인증 정보를 담은 후 MongoClient를 생성해줍니다. 


line 24

API 개발 프로젝트에서 @Query Annotation을 사용해서 동적 쿼리를 작성한 적이 있는데,  MySQL 문과 많이 다른 데다가, SpEL은 또 처음이라 고생 많았던 기억이 있습니다. 저처럼 Mongo Query보다 SQL 계열이 익숙하다면 이 mongoTemplete를 이용하여, 최대한 비슷하게 쿼리를 작성할 수 있습니다. 진작에 알았더라면 @Query Annotation 안 썼습니다.(삽질이 소중한 이유이기도 하죠.) DAO 클래스에서 사용하기 위해서 @Bean로 등록하여 DAO 클래스에서 @Autowired로 주입하여 사용이 가능도록 합시다.


ReplyDomain.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@Data
@Document(collection="reply")
public class ReplyDomain implements Serializable{
    
    private static final long serialVersionUID = 1L;
 
    @Id
    private String id;
    private int bno;
    private int rno;
    private String contents;
    private String userName;
}
 
cs

@Document Annotation은 Collection 내의 하나의 Document에 대응합니다. Collection 명도 넣어줘서 나중에 어떤 Collection에 접근하여 데이터를 가져오는지를 명시해 줍니다. 


@Data Annotation은 Project Lombok 라이브러리를 Maven에 등록하고 jar 파일로 STS 또는 이클립스에 적용해야 제대로 적용되는 Annotation입니다. getter와 setter, toString() 등을 자동으로 만들어주는 정말 편리한 기능입니다. 개인적으로 getter / setter 자동 완성보다 toString() 자동 완성 기능이 편리했습니다. 로그를 찍을 때, 참 편리하게 데이터를 확인할 수 있기 때문이죠. Lombok을 적용하는 방법도 포스팅으로 소개하겠습니다.


ReplyRepo.java

1
2
3
4
5
public interface ReplyRepo extends MongoRepository<ReplyDomain, Long>{
    public List<ReplyDomain> findByBno(int bno);
    public List<ReplyDomain> findAll();
}
 
cs


두 가지 방법으로 Mongo DB에 데이터를 가져오는 방법을 소개하고자 합니다. 


첫 번째는 위의 ReplyRepo.java 코드처럼 MongoRepository<DataType, SerializeType> 클래스를 상속하여 사용하는 방법입니다. findByBno처럼 사전에 정의된 Action(Find 등등)과 조건(ByBno, All 등등)을 이용하여 함수 이름을 만들어주면 알아서 해당하는 쿼리를 수행합니다. 이 방법은 조건이 매우 단순한 경우에 쉽게 데이터베이스에 접근하는 방법을 제공합니다.  


이 방법으로 정의하기 힘든 복잡한 쿼리를 사용해야 하는 경우에는 @Query Annotation을 사용하여 구현합니다. MongoDB 쿼리에 익숙하다면 이 방법으로 구현하는 것도 좋습니다.


ReplyServiceImpl.java

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
@Autowired
private ReplyRepo replyRepo;
    
@Autowired
private MongoTemplate mongoTemplete;
// --- 첫 번째(Repo) 방법 사용시 ----- //
@Override
public List<ReplyDomain> findbyBno(int bno) {
    logger.info("Go Mongo");
    return replyRepo.findByBno(bno);
}
 
// --- 두 번째(Templete) 방법 사용 ----- // 
@Override
public List<ReplyDomain> insert(ReplyDomain reply) {
    int bno = reply.getBno();    
    mongoTemplete.insert(reply);
    return replyRepo.findByBno(bno);
}
 
@Override
public List<ReplyDomain> update(ReplyDomain reply) {
    int bno = reply.getBno();
        
    ObjectId id = new ObjectId(reply.getId());
    Query query = new Query();
    query.addCriteria(Criteria.where("_id").is(id));
        
    Update update = new Update();
    update.set("userName", reply.getUserName());
    update.set("contents", reply.getContents());
    
    WriteResult writeResult = mongoTemplete.updateFirst(query, update, ReplyDomain.class);
    logger.info(writeResult.toString());
            
    return replyRepo.findByBno(bno);
}
cs


두 번째 방법은 앞서 설명한 MongoTemplete를 이용하는 방법입니다. 개인적으로는 두 번째 방법을 선호합니다. Query 클래스와 Criteria 클래스로 조건을 만들고 Update 객체로 수정 할 내용을 넣습니다. 그리고 MongoTemplete 객체의 메서드를 이용하여 실행합니다. 코드를 보다 보면 눈에 익숙한 where 절도 보이고 update에선 set도 보여서, SQL처럼 사용하기가 쉽습니다. 그리고 동적 쿼리가 필요한 경우에는 Java 소스코드 내에서 if문을 이용하면 구현이 쉽습니다.  간단한 거는 첫 번째로, 복잡한 것은 두 번째로 작성하는 것을 추천합니다. 




다음 포스팅에서는 Swagger를 이용하여 자동으로 API Document를 작성하는 방법을 포스팅하겠습니다.



저작자표시

'Spring Framework' 카테고리의 다른 글

[Spring Boot]2-2. RestController with Swagger2  (6) 2018.01.21
[Spring Boot]1-2. 간단한 게시판 만들기 (Modal로 깔끔하게 만들자)  (5) 2018.01.16
[Spring Boot]1-1. 간단한 게시판 만들기 (MySQL과 데이터 주고 받기)  (0) 2018.01.12
Chan Ho Son
,

달력

«   2024/05   »
일 월 화 수 목 금 토
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
05-09 11:56

티스토리툴바