캐모마일 UI Adapter 가이드

개요

흐름도

[그림] UIAdapter흐름도

기능 Overview

기능설명

데이터타입 매핑

java types	nexacro	Xplatform	websquare
byte[], java.lang.Byte[]	BLOB	BLOB
int, java.lang.Integer	INT	INT	int
long, java.lang,Long	LONG	LONG
float, java.lang.Float	FLOAT	FLOAT	float
double, java.lang.Double	DOUBLE	DOUBLE	double
boolean, java.lang.Boolean	BOOLEAN	BOOLEAN
java.lang.String	STRING	STRING	String
java.math.BigDecimal	BIG_DECIMAL	BIG_DECIMAL	BigDecimal
java.util.Date	DATE	DATE	Date
	DATE_TIME	DATE_TIME
	TIME	TIME
Java.lang.Object	UNDEFINED	UNDEFINED

데이터 입력

Argument 타입	설명	옵션	비고
@RequestParam	일반적으로 key/value 형식의 데이터를 획득할 때 사용된다. (단일 데이터 처리) 기본적으로는 어노테이션에 명시 된 이름을 통해 데이터를 획득하고, 이름이 명시되지 않은 경우 파라매터의 타입을 통해 데이터를 획득한다. 옵션 : required와 defaultValue를 추가적으로 설정할 수 있다.	required defaultValue	어노테이션을 지정하지 않아도 동작한다. 예제 : public void handle(@RequestParam(“userId”) String userId)
@ModelAttribute	요청 된 파라매터 정보와 선언 된 객체와의 매핑을 수행한다. (2차원 데이터 처리) @RequestParam과 동일한 이름정책을 가진다. binding을 추가적으로 설정할 수 있다. @Valid 어노테이션과 사용 가능하다.	binding	메서드 레벨에 선언되는 경우 선처리 기능으로 동작 가능 어노테이션을 지정하지 않아도 동작한다. 예제 : public void handle(@ModelAttribute(“address”) Address address)
HttpEntity\<T\> or RequestEntity\<T\>	Http 요청의 헤더와 본문으로 구성 된 엔티티이다. (단일/2차원 데이터가 합쳐진 데이터) 내부적으로는 HttpMessageConverter를 이용하여 본문를 구성한다.		전체 요청 데이터를 하나의 객체로 변환한다. 예제 : public void handle(HttpEntity\<User\> httpEntity)
@RequestBody	Http 요청의 본문을 명시 된 파라매터로 구성한다. (단일/2차원 데이터가 합쳐진 데이터) 내부적으로 HttpMessageConverter를 이용하여 본문을 구성한다. @Valid 어노테이션과 사용 가능하다.	required	전체 요청 데이터를 하나의 객체로 변환한다. 예제 : public void handle(@RequestBody User user)

데이터 출력

Argument 타입	설명	비고
Model	Model 인터페이스를 구현한 객체 반환을 허용한다. 추가된 데이터는 primitive 타입인 경우 단일데이터로 판단하고, 그 외 데이터는 2차원 데이터로 판단하여 응답한다.
ModelAndView	Model과 동일한형태이며, UI 솔루션을 사용하게 되는 경우 View는 명시적으로 지정할 필요가 없다. 단, UserController와 같은 UI 솔루션과 일반 JSP에서 동일하게 호출한다면 ModelAndView를 사용하여 view를 지정할 수 있습니다.
HttpEntity\<T\> or ResponseEntity\<T\>	Http 응답의 헤더와 본문으로 구성 된 엔티티이다. View를 처리하지 않으며, Entity(데이터) 자체를 응답으로 구성한다. Bean으로 반환되는 경우 해당 Bean에 단일데이터와 2차원데이터가 합쳐져 있어야 한다.
@ResponseBody	Http 응답의 본문으로 구성한다. View를 처리하지 않으며, 대상 자체를 응답으로 구성한다. Bean으로 반환되는 경우 해당 Bean에 단일데이터와 2차원데이터가 합쳐져 있어야 한다.	List로 반환되는 경우 2차원 데이터로 인식하여 응답한다.

프로젝트 설정

캐모마일 샘플 프로젝트 생성(ex. chamomile-sample-boot-security-adapter-nexacro)

pom.xml 확인

<dependencies>
	<dependency><!-- 벤더에 맞는 어댑터 적용 -->
	    <groupId>net.lotte.chamomile.module</groupId>
	    <artifactId>chamomile-adapter-nexacro</artifactId>
	</dependency>
    <dependency>
        <groupId>net.lotte.chamomile.module</groupId>
	    <artifactId>chamomile-security-adapter</artifactId>
	</dependency>
</dependencies>

application.yml 파일 확인 후 excludePatterns 적용

chmm:
  uiadapter:
    excludePatterns: /index.html,/favicon.ico

업무시스템 개발하기

Controller 구성

demo.user.controller.UserController.java

import com.nexacro.uiadapter.spring.core.data.NexacroResult;

import demo.user.controller.dto.SearchRequest;
import demo.user.controller.dto.UserRequest;
import demo.user.controller.dto.UserResponse;
import demo.user.domain.User;
import demo.user.service.UserService;
import lombok.RequiredArgsConstructor;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.List;
import java.util.stream.Collectors;

@Controller
@RequiredArgsConstructor
@RequestMapping(path = "/model-attribute")
public class UserController {
    private final UserService userService;

    @RequestMapping(value = "/user/list")
    public ModelAndView getUserList(@ModelAttribute(name = "input1") SearchRequest request) {
        List<User> userList = userService.getUsersBySearchRequest(request);
        List<UserResponse> results = userList.stream().map(UserResponse::of).collect(Collectors.toList());
        ModelAndView mv = new ModelAndView();
        mv.addObject("output1", results);
        return mv;
    }


    @RequestMapping(value = "/user/update")
    public ModelAndView updateUserList(@ModelAttribute(name = "input1") List<UserRequest> request) {
        userService.updateUserList(request);
        return new ModelAndView();
    }
}

Service 구성

demo.user.service.UserService.java

import demo.user.controller.dto.SearchRequest;
import demo.user.controller.dto.UserRequest;
import demo.user.domain.User;

import java.util.List;
import java.util.Map;

public interface UserService {
    List<User> getUsersBySearchRequest(SearchRequest searchRequest);
    void updateUserList(List<UserRequest> userRequests);
}

demo.user.service.UserServiceImpl.java

import com.nexacro.java.xapi.data.DataSet;
import demo.user.controller.dto.SearchRequest;
import demo.user.controller.dto.UserRequest;
import demo.user.domain.User;
import demo.user.domain.UserMapper;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
@RequiredArgsConstructor
public class UserServiceImpl implements UserService {

    private final UserMapper userMapper;

    @Override
    public List<User> getUsersBySearchRequest(SearchRequest searchRequest) {
        return userMapper.findUsers(searchRequest);
    }
    @Override
    public void updateUserList(List<UserRequest> userRequests) {
        for (UserRequest userRequest : userRequests) {
            User user = userRequest.convertToUser();
            if (isInsertType(userRequest)) {
                userMapper.insertUserList(user);
                continue;
            }
            if (isUpdateType(userRequest)) {
                userMapper.updateUserList(user);
                continue;
            }
            if (isDeleteType(userRequest)) {
                userMapper.deleteUserList(user);
            }
        }
    }

    private boolean isDeleteType(UserRequest userRequest) {
        return userRequest.getRowType() == DataSet.ROW_TYPE_DELETED;
    }

    private boolean isUpdateType(UserRequest userRequest) {
        return userRequest.getRowType() == DataSet.ROW_TYPE_UPDATED;
    }

    private boolean isInsertType(UserRequest userRequest) {
        return userRequest.getRowType() == DataSet.ROW_TYPE_INSERTED;
    }
}

VO 구성

demo.user.domain.User.java

import lombok.*;

import javax.persistence.*;

@Entity
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
@EqualsAndHashCode
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "ID")
    private Long id;
    @Column(name = "NAME")
    private String name;
    @Column(name = "DESCRIPTION")
    private String description;
    @Column(name = "USE_YN")
    private Boolean useYn;
    @Column(name = "REG_USER")
    private String regUser;
}

Mapper 구성 demo.user.domain.UserMapper.java

import demo.user.controller.dto.SearchRequest;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;

@Mapper
public interface UserMapper {
    List<User> findUsers(SearchRequest request);
    void insertUserList(User sample);
    void updateUserList(User sample);
    void deleteUserList(User sample);
}

XML 매퍼 구성 resources/sql/service/UserMapper.xml

<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="demo.user.domain.UserMapper">

    <resultMap id="user" type="demo.user.domain.User">
        <id column="ID" property="id"/>
        <result column="NAME" property="name"/>
        <result column="DESCRIPTION" property="description"/>
        <result column="USE_YN" property="useYn"/>
        <result column="REG_USER" property="regUser"/>
    </resultMap>
    <select id="findUsers" parameterType="demo.user.controller.dto.SearchRequest" resultMap="user">
        SELECT *
        FROM USER        WHERE 1=1        <if test="keyword != null and keyword != ''">
            <choose>
                <when test="searchType == 'ID'">
                    AND ID = #{keyword}
                </when>
                <when test="searchType == 'NAME'">
                    AND NAME LIKE #{keyword}
                </when>
            </choose>
        </if>
        ORDER BY ID ASC
    </select>

    <insert id="insertUserList" parameterType="demo.user.domain.User">
        INSERT INTO USER ( ID
                         , NAME                         , DESCRIPTION                         , USE_YN                         , REG_USER)        VALUES ( #{id}               , #{name}               , #{description}               , #{useYn}               , #{regUser})    </insert>

    <update id="updateUserList" parameterType="demo.user.domain.User">
        UPDATE USER
        SET ID=#{id}          , NAME=#{name}          , DESCRIPTION=#{description}          , USE_YN=#{useYn}        WHERE ID = #{id}    </update>

    <delete id="deleteUserList" parameterType="demo.user.domain.User">
        DELETE
        FROM USER        WHERE ID = #{id}    </delete>
</mapper>

특이사항

행 처리타입 예제 코드

import com.nexacro.uiadapter.spring.core.data.DataSetRowTypeAccessor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@NoArgsConstructor
public class RowTypeVO implements DataSetRowTypeAccessor {
    private int rowType;

    @Override
    public void setRowType(int rowType) {
        this.rowType = rowType;
    }}

import demo.user.domain.User;
import lombok.Getter;
import lombok.Setter;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

@Getter
@Setter
public class UserRequest extends RowTypeVO {
    private Long id;
    private String name;
    private String description;
    private String useYn;
    private String regUser;

    public User convertToUser() {
        return User.builder()
                .id(id)
                .name(name)
                .description(description)
                .useYn(convertUseYn())                .regUser(regUser)
                .build();    }
    public static List<UserRequest> ofList(List<Map<String,Object>> request) {
        List<UserRequest> list = new ArrayList<>();
        for (Map<String, Object> map : request) {
            UserRequest userRequest = new UserRequest();
            userRequest.setId(Long.parseLong((String)map.get("id")));
            userRequest.setName((String) map.get("name"));
            userRequest.setDescription((String) map.get("description"));
            userRequest.setUseYn((String) map.get("useYn"));
            userRequest.setRegUser((String) map.get("regUser"));
            int dataSetRowType = (int)map.get("DataSetRowType");
            userRequest.setRowType(dataSetRowType);
            list.add(userRequest);
        }        return list;
    }
    public Boolean convertUseYn() {
        return useYn.equals("Y");
    }}

캐모마일 UI Adapter 가이드﻿

개요﻿

흐름도﻿

tip

기능 Overview﻿

기능설명﻿

데이터 변환﻿

데이터타입 매핑﻿

데이터 입력﻿

tip

note

데이터 출력﻿

note

프로젝트 설정﻿

업무시스템 개발하기﻿

특이사항﻿

행의 타입 (RowType)﻿

행 처리타입 예제 코드﻿

UI Adapter 샘플코드﻿