기본 콘텐츠로 건너뛰기

냉장고 가계부 프로젝트 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
라벨:

이 블로그의 인기 게시물

냉장고 가계부 프로젝트 14

fridge-web 프로젝트에서 api 서버와 통신할때 URL을 매번 중복해서 입력하는 부분을 제거하기 위해 RestTemplate 빈 등록메서드를 수정한다. @Bean public RestTemplate restTemplate(RestTemplateBuilder builder) { return builder.rootUri("http://localhost:8081").build(); } builder에 rootUri 메서드를 호출해서 api 서버 url을 미리 설정하고 build해서 RestTemplate 객체를 반환하면 RestTemplate을 사용하는 부분에서는 root 다음 경로만 넘겨주면 된다. WebFoodController 클래스의 restTemplate 사용부분을 전부 수정한다. @GetMapping public String foods(Model model) { ResponseEntity<Resources<FoodCommand>> response = restTemplate.exchange("/foods", HttpMethod.GET, null, new ParameterizedTypeReference<Resources<FoodCommand>>() {}, Collections.emptyMap()); .... 다른 메서드들도 동일하게 수정한다. Food 클래스에서도 이제 더이상 사용하지 않는 Cloneable과 hashCode, equals 메서드를 정리한다. Guava 의존라이브러리도 다른곳에서는 사용하지 않으므로 정리한다. 식품에 대한 최소한의 기능은 구현하였다. 이번에는 냉장고 라는 개념을 모델링한다. 식품들이 들어가고 나가는 곳은 냉장고이기 때문에 냉장고라는...
자세한 내용 보기

냉장고 가계부 프로젝트 27

스프링 Data 에서 제공하는 @CreatedDate, @LastModifedDate 애너테이션을 이용해서 작성일자, 수정일자를 도메인객체가 생성되고, 수정될 때 관리될 수 있도록 한다. Spring Data를 쓰기 전에는 DB컬럼에 Date 타입의 등록일 컬럼을 추가하고 DEFAULT 값으로 SYSDATE 를 줘서 DB에 Insert 되는 시간에 등록일자 컬럼이 채워지는 방식을 사용했었고, Update 쿼리가 실행될때 수정일자 컬럼에 SYSDATE를 직접 Update 해주는 방식을 자주 썼다. 그 뿐만아니라, 등록일자와 더불어 등록한 사용자(ex: registerUser)를 식별하는 식별키(ex: userId, username ...) 를 Insert 쿼리가 실행될때 등록해주고, 수정한 사용자(ex: modifedUser)를 Update 쿼리에 설정하는 방식은 차후에 있을지도 모를 일에 대비해서 늘 반복해서 작업했다. 스프링 Data 에서 제공하는 JPA Audit 기능은 이런 코드의 반복을 줄여준다. 사용자 같은 경우 객체로 넘기면 객체의 식별자가 담긴다. 등록시간은 날짜형 타입이다. public class Blog { @CreatedBy private User user; @CreatedDate private LocalDateTime creadtedDate; } Blog 클래스의 User 객체는 @CreatedBy 애너테이션으로 선언되서 등록한 사용자를 나타내는 컬럼에 값을 입력할것이다. createdDate 필드는 도메인객체가 영속성 저장소에 반영되는 시간을 나타낸다. Fridge, Food 클래스에 등록일, 수정일만 먼저 적용한다. 두 클래스에 createdDate, lastModifedDate 멤버변수를 선언한다. @Data @NoArgsConstructor @Entity @EntityListeners(AuditingEntityListener.class) public class Fridge { ...
자세한 내용 보기

냉장고 가계부 프로젝트 10

API 가 어느정도 준비되었으므로, UI를 만든다. 별도의 프로젝트로 구성해서 API를 호출하는 방식으로 구성한다. 프로젝트명은 fridge-web이라고 정한다. 냉장고 가계부 프로젝트 1 을 참고한다. 새 프로젝트에서는 Dependencies를 Web, Thymeleaf, DevTools 세개를 체크한다. 프로젝트가 준비되면, pom.xml 파일을 연다. <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <gro...
자세한 내용 보기