기본 콘텐츠로 건너뛰기

냉장고 가계부 프로젝트 16

Fridge UI를 구현하기위해 fridge-web 프로젝트를 작업한다. 여기에도 앞에 글에서 정리한것과 같이 패키지 정리가 안되어 있으므로 패키지를 정리한다. food 패키지와 fridge 패키지로 나누고 각 클래스들을 옮긴다.
테스트 클래스들도 마찬가지로 패키지를 구분한다.

Fridge 를 표현하는 FridgeController 를 작성하고 테스트 클래스를 만든다. FridgeControllerTests 클래스는 Selenium으로 웹UI를 테스트하는 테스트 클래스이다.
이미 FoodControllerTests 클래스에서 selenium API를 사용하는 부분이 존재하고 FridgeController 에서도 별 차이없을 것이므로 selenium WebDriver 할당부분등의 중복되는 부분은 추상클래스(ControllerBase)로 옮기고 FoodControllerTests와 FridgeControllerTests 클래스에서 상속받는 구조로 작성한다.

다음은 ControllerBase 클래스 소스코드이다.
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)
public abstract class ControllerBase {
    
    protected static ChromeDriver browser;
    
    @Autowired
    protected RestTemplate restTemplate;
    
    @Value("${local.server.port}")
    private int port;
    private String host = "http://localhost";
    protected static String BASE_URL;
    
    @Before
    public void setUp() {
        BASE_URL = host + ":" + port;
    }
    
    @BeforeClass
    public static void openBrowser() {
        System.setProperty("webdriver.chrome.driver", "/Users/gang-yeongho/Documents/chromedriver");
        browser = new ChromeDriver();
        browser.manage().timeouts().implicitlyWait(10, TimeUnit.SECONDS);
    }
    
    @AfterClass
    public static void closeBrowser() {
        browser.quit();
    }

}

ChromeDriver, RestTemplate 객체는 하위 클래스에서 사용할 수 있도록 protected로 선언한다. 서버 접근경로와 포트는 굳이 노출할 필요가 없으므로 private으로 가져가고 BASE_URL 을 protected로 선언한다. BASE_URL을 할당하는 부분이 @Before애너테이션으로 선언된 setUp메서드인데, 이 부분은 하위 클래스에서 오버라이드 할 경우가 생기면 추상메서드를 선언해서 setUp을 호출하는 패턴으로 차후 변경될 가능성이 있다.
@BeforeClass, @AfterClass 부분은 WebDriver 객체가 사용하는 드라이버 파일을 환경변수로 선언하고 할당하는 부분과 브라우져를 종료하는 기능을 가지는데, 공통적으로 하위 컨트롤러 테스트클래스에서 사용될 것이므로 ControllerBase 추상클래스에 작성한다.

다음은 FoodControllerTests 클래스의 변경된 소스코드의 일부이다.
public class FoodControllerTests extends ControllerBase {
    
    @Test
    public void registerFood() {
        String name = "파스퇴르 우유 1.8L";
        int quantity = 1;
        
        browser.get(BASE_URL + "/foods");
        browser.findElement(By.id("btnRegistrationFood")).click();
...

클래스 선언부가 다 사라지고 extends 부분이 추가되었다. 클래스 멤버변수들과 @Before, @BeforeClass, @AfterClass를 선언한 메서드들이 다 사라졌다.
이번에는 FridgeControllerTests 클래스의 소스코드이다. FoodController 와 ui는 차이가 없으므로 목록페이지에서 등록버튼을 찾아서 클릭하고, form 내부의 input값들을 채운뒤 submit하는 등록프로세스를 검증한다.
public class FridgeControllerTests extends ControllerBase {
    
    @Test
    public void create() {
        browser.get(BASE_URL + "/fridges");
        browser.findElementById("btnCreateFridge").click();
        
        String nickname = "myFridge";
        WebElement nicknameElement = browser.findElement(By.name("nickname"));
        nicknameElement.sendKeys(nickname);
        browser.findElementByTagName("form").submit();
        
        WebDriverWait wait = new WebDriverWait(browser, 10);
        wait.until(ExpectedConditions.alertIsPresent());
        Alert alert = browser.switchTo().alert();
        assertThat(alert.getText()).isEqualTo(nickname + "을 생성했습니다.");
        alert.accept();
    }

}

URL /fridges 를 호출하면 냉장고 목록페이지가 나타나고, 해당 페이지에서 btnCreateFridge라는 id를 가지고있는 Element를 찾아서 클릭한다. 페이지가 이동하고 등록 폼 페이지에서 name속성이 nickname이라는 Element의 value값을 "myFridge" 로 입력하고 form태그를 찾아서 submit한다.
WebDriver는 alert 창이 뜰때까지 10초정도 기다린다. alert창이 나오면 alert 텍스트를 읽어서 예상되는 메시지와 동일한지 검증한다. 검증이 성공하면 alert창에 동의한다.

다음은 냉장고 목록페이지인 fridges.html 파일이다.
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
  <title>Fridge</title>
  <script th:inline="javascript" th:if="${!#strings.isEmpty(registerMessage)}">
  alert([[${registerMessage}]]);
  </script>
</head>
<body>
  <h2>Fridges</h2>
  <a href="/fridges/add" th:href="@{/fridges/add}" id="btnCreateFridge">등록</a>
</body>
</html>

냉장고 등록폼페이지 registerFridgeForm.html는 다음과 같이 구현한다.
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
  <title>Fridge</title>
</head>
<body>
  <h2>냉장고 등록</h2>
  <form th:action="@{/fridges/add}" th:object="${fridgeCommand}" th:method="post">
 <div th:if="${#fields.hasErrors('*')}">
     <ul>
         <li th:each="err : ${#fields.errors('*')}" th:text="${err}">Input is incorrect</li>
     </ul>
 </div>
    <label for="nickname">이름: 
     <input type="text" th:field="*{nickname}" />
    </label><br/>
    <button type="submit">저장</button>
  </form>
</body>
</html>

foods 목록페이지, 등록폼페이지 파일과 냉장고 목록, 등록폼 페이지의 차이가 크게 없으므로 설명은 생략 한다. 다음은 View와 Controller 사이에서 데이터 전달을 책임지는 Command객체를 구현한다. 클래스명은 FridgeCommand 이며 FoodCommand와 구현이 동일하다.
public class FridgeCommand {
    private Integer id;
    @NotNull
    @Size(min=2, max=15)
    private String nickname;
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getNickname() {
        return nickname;
    }
    public void setNickname(String nickname) {
        this.nickname = nickname;
    }

}

멤버변수와 Getter/Setter, Validation을 위한 @NotNull, @Size 애너테이션이 nickname 변수에 선언되어있다. nickname은 최소 2자, 최대 15자를 입력받는다.

다음은 FridgeController 컨트롤러 클래스의 소스코드이다.
@Controller
@RequestMapping("/fridges")
public class FridgeController {
    
    @Autowired
    private RestTemplate restTemplate;
    
    @GetMapping
    public String fridges(Model model) {
        return "fridges/fridges";
    }
    
    @GetMapping("/add")
    public String registerFridgeForm(@ModelAttribute("fridgeCommand") FridgeCommand fridgeCommand) {
        return "fridges/registerFridgeForm";
    }
    
    @PostMapping("/add")
    public String processRegistrationFridge(@Valid FridgeCommand fridgeCommand, Errors errors, RedirectAttributes ra) {
        if(errors.hasErrors()) {
            return "fridges/registerFridgeForm";
        }
        
        ResponseEntity<FridgeCommand> response = restTemplate.postForEntity("/fridges", fridgeCommand, FridgeCommand.class);
        if(response.getStatusCode().is2xxSuccessful()) {
            ra.addFlashAttribute("registerMessage", fridgeCommand.getNickname() + "을 생성했습니다.");
        }
        return "redirect:/fridges";
    }

}

클래스는 /fridges URL로 매핑되며 GET 방식으로 호출시 fridges 메서드로 매핑되며 목록페이지 View를 반환한다. /fridges/add URL은 GET방식일경우, 등록폼 페이지로 전달되고 POST방식은 등록 처리를 담당하는 processRegistrationFridge 메서드로 매핑된다. FoodController 와 유사하다.

이전글: 냉장고 가계부 프로젝트 15
다음글: 냉장고 가계부 프로젝트 17

이 블로그의 인기 게시물

Dolphin 3

100자 이내의 짧은 글을 쓸 수 있는 게시판 제공. Dolphin Project에서 가장 메인 서비스는 예적금 시뮬레이터이므로, 다른 기능 구현은 차후로 미뤄뒀지만, 사용자와 소통할 수 있는 최소한의 기능은 제공하는게 맞다는 생각이 들어 아주 단순한 게시판 기능을 제공합니다. 사용자가 글을 쓰려면 로그인을 먼저 해야합니다. 글을 등록 후 삭제할 때 글 작성자를 식별할 수 있어야 하기 때문입니다. 게시판은 Dolphin Frontend Main 페이지에 자리잡았습니다. 사용자가 가장 먼저 만나게 되는 웹페이지이므로 적당하다고 생각합니다. 다음은 로그인을 하기 전 사용자가 볼 수 있는 메인 페이지입니다. 글 상단에는 작성일(MMM-dd-yyyy)과 작성자 고유번호(#numbers)가 노출됩니다. Dolphin 은 네이버 로그인을 사용하기 때문에, 사용자를 식별할 수 있는 정보는 저 고유번호가 됩니다. 하단에는 글 내용이 자리잡습니다. 스크린샷에서는 Hello, world!! 라는 문구가 보이네요. 글은 최대 100자까지 허용합니다. 버튼 두개(Newer, Older) 는 페이징 버튼인데, Newer는 최근페이지로 이동을 하며, Older는 지나간 글을 보는 페이징버튼입니다. 기본 페이지 사이즈는 20개입니다. 오른쪽으로 보이는 글 작성 폼은 현재 로그인 하기 전이므로 textarea 는 disabled 처리되어 있고 Login버튼이 자리잡고 있습니다. 다음은 사용자가 로그인 한 뒤의 메인페이지입니다. 변경된 부분은 사용자 고유번호 뒤에 Remove 버튼이 나타났습니다. 해당 글 작성자가 로그인한 사용자일 경우에만 보이게 됩니다. 오른쪽 글 작성 폼도 이제 활성화 되었습니다. 아주 단순한 Textarea 창과 Submit 버튼이 자리잡고 있습니다. 다음은 작성자가 아닌 다른 사용자가 로그인한 경우 입니다. 사용자 고유번호(#54097272) 옆에 Remove 버튼이...

Dolphin 2

별도의 회원가입 없이 소셜 로그인 기능 제공으로 간편한 로그인 가능. Dolphin 프론트엔드는 회원가입 절차가 따로 없고, 간단하게 소셜 로그인 기능을 제공함으로써 회원가입, 인증절차를 생략했습니다. 우선, 간단하게 국내에서 잘 알려진 네이버의 API를 사용합니다. 네이버 개발자센터 웹사이트 에서 네이버 아이디로 로그인 기능을 살펴봅니다. 개발 문서를 자세히 살펴보고 API 신청을 합니다. 애플리케이션의 이름을 정하고 필요한 정보를 필수/선택에 체크합니다. 밑으로 내려보면 로그인 API 서비스 환경 부분에서 환경 추가 셀렉트박스에서 PC 웹을 선택하면 다음과 같은 입력폼이 나타납니다. 서비스 URL은 내 웹애플리케이션의 URL이 될 예정입니다. 지금은 개발상태이므로 localhost를 입력했습니다. Callback URL은 네이버 OAuth 인증 url로 호출하면, 인증절차 후 네이버에서 리다이렉트해줄 url을 뜻합니다. 저는 /naver/login 으로 했습니다. 등록이 완료되면 client-id와 client-secret 값을 제공해줍니다. 이 값을 이용해서 인증처리를 할 수 있습니다. spring.io 웹사이트의 튜토리얼 문서를 보면 Facebook 소셜 로그인 기능에 대한 설명이 자세하게 나와있습니다. 이 부분을 참고합니다. Spring Boot and OAuth2 pom.xml 파일에 의존성을 추가하고 Application 클래스에 @EnableOAuth2Sso 애너테이션을 선언합니다. 튜토리얼대로 application.yaml 파일(application.properties)에 설정 정보를 입력합니다. clientId, clientSecret 값은 네이버 개발자센터에서 받은 대로 입력합니다. accessTokenUri는 네이버의 경우 https://nid.naver.com/oauth2.0/token 입니다. userAuthorizationUri는 네이버의 경우 https://ni...

Dolphin 1

금융감독원 OPEN API를 사용하여 데이터 수집 금융감독원 금융상품통합비교공시 사이트에서 제공하는 OPEN API 를 사용합니다. 먼저, API 키를 신청합니다. https://finlife.fss.or.kr/PageLink.do?link=openapi/certification&menuId=2000119  로 접속합니다. 약관에 동의하고 본인인증 후, 신상정보를 넘기면 바로 API 키를 받을 수 있습니다. 상세 및 테스트 페이지를 들어가보면 요청 파라미터와 응답 API 형태를 확인할 수 있습니다. 요청은 다음과 같습니다. 읽어보면 서비스 명에 따라 url이 달라지는 부분을 제외하면 요청 URL은 크게 달라지지 않습니다. 파라미터에 인증키, 권역코드, 페이지번호를 전달하면 됩니다. 응답부분은 서비스마다 다르지만 공통 응답 형태는 다음과 같습니다. 에러코드, 에러메시지, 전체 개수, 전체 페이지, 현재 페이지 번호 입니다. 예금상품 조회 서비스나 적금상품 조회 서비스의 경우 공통적으로 금융회사 코드와 이름을 전달해주는데 해당 금융회사의 상세한 정보를 보려면 금융회사 조회 서비스도 호출하는게 나중에 좋을것 같습니다. Spring으로 HTTP 통신을 위해서 Apache HttpComponent 라이브러리를 사용합니다. 메이븐에 다음과 같이 의존성을 추가합니다. <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> </dependency> 다음은 API를 호출하는 간단한 소스코드 조각입니다. CloseableHttpClient httpClient = HttpClients.createDefault(); URI uri = new URIBuilder() .setScheme("http") .setHos...