Excel Object Mapper

EOM(Excel Object Mapper)는 Excel 데이터를 미리 정의한 @ExcelObject & @ExcelColumn 값에 따라 매핑하는 라이브러리입니다.

@ExcelObject

다음 에너테이션은 Class에 설정가능합니다. 시트이름과 시트의 색상을 설정할 수 있습니다.

필수적이지 않으며 설정하지 않을 경우 기본값으로 설정됩니다.

name : 시트의 이름을 설정합니다. (default : "default")
uniqueKeys : 유니크항목을 지정하는 메타데이터
cellColor : Cell 색상 (default : IndexedColors.YELLOW)
borderStyle : 테두리 스타일 (default : BorderStyle.THIN)
borderColor : 테두리 색상 (default : IndexedColors.BLACK)
fixedRowCount : 상단 고정 행 개수 (default : 0)
fixedColumnCount : 왼쪽 고정 열 개수 (default : 0)

@Excelobject(name="default", uniqueKeys={"name"})
public class Inventory {
    
    @ExcelColumnt(name="NAME", index=0)
    public String name;
    
    @ExcelColumn(name="COUNT", index=1)
    public Integer count;
    
}

@ExcelColumn

시트의 Column을 정의하는 어노테이션입니다.

name : Column 노출 이름
index : Column 순서
group : Column 그룹
- 그룹이란, Column의 동일한 항목을 묶어 노출하는 기능을 말합니다.
dropdown : 동적 Dropdown Key
nullable : 빈값 가능 여부 (default : true)
width : 넓이 (default : 15)
alignment : 정렬 (default : CellStyle.ALIGN_CENTER)
cellColor : Cell 색상 (default : IndexedColors.WHITE)
borderStyle : 테두리 스타일 (default : BorderStyle.THIN)
borderColor : 테두리 색상 (default : IndexedColors.BLACK)

기본예제

public class Inventory {
 
    @ExcelColumn(name="NAME", index=0)
    public String name;
    
    @ExcelColumn(name="COUNT", index=1)
    public Integer count;
    
}

Dropdown

드랍다운예제 A (Enum)

자료형에 Enum을 사용할 경우 엑셀에서 Dropdown으로 구성됩니다.

public enum Planet {
    Earth,
    Asgard,
    Titan
}

public class Inventory {

    @ExcelColumnt(name="NAME", index=0)
    public String name;
    
    @ExcelColumn(name="COUNT", index=1)
    public Integer count;

    @ExcelColumn(name = "PLANET", index = 2)
    public Planet planet;

}

드랍다운예제 B (Dymamic)

드랍다운을 동적으로 구성할 때, Dropdown 클래스를 사용하여 데구성할 수 있습니다.
Dropdown 인스턴스를 생성한 후, initDropdowns() 메소드에 Dynamic Dropdown 인스턴스를 넣어줍니다.
@ExcelColumn내에 dropdown 속성값에 동적 Dynamic Dropdown의 key 값을 선언합니다.
주의할 점으로 dropdown 항목인 fruitKey는 노출 값이 아닌 key 값으로 설정된 다는 것입니다.

Map optionMap = new HashMap<>();
optionMap.put("apple", "a");
optionMap.put("banana", "b");
optionMap.put("cherry", "c");
Dropdown dropdownA = new Dropdown("dropdown_key", optionMap);

ExcelObjectMapper.init()
    .initDropdowns(dropdownA, ..)

public static class Inventory {

    @ExcelColumn(name = "NAME", index=0)
    public String name;

    @ExcelColumn(name = "COUNT", index=1)
    public Integer count;

    @ExcelColumn(name = "FRUIT", index=2, dropdown="dropdown_key")
    public String fruitKey;

}

Group

그룹예제 A

group의 기본값을 0이며, 숫자가 커질 수록 상위 그룹을 의미합니다.
group으로 데이터가 묶여 노출되기 때문에 같은 이름이 있어선 안됩니다.

public class Inventory {
    
    @ExcelColumnt(name="CATEGORY", index=0, group=1)
    public String category;
    
    @ExcelColumnt(name="NAME", index=1)
    public String name;
    
    @ExcelColumn(name="COUNT", index=2)
    public Integer count;
    
}

그룹예제 B

같은 Group이 2개 이상일 경우
- index가 높은 필드에 따라 그룹 범위가 정해지며, index가 낮은 필드는 이미 정해진 그룹 범위를 따라 갑니다.

public class Inventory {

    @ExcelColumn(name = "PARENT", group = 2, index = 0)
    public String parentGroup;

    @ExcelColumn(name = "PARENT_NAME", group = 2, index = 1)
    public String parentGroupName;

    @ExcelColumn(name = "NAME", index = 3)
    public String name;

    @ExcelColumn(name = "COUNT", index = 4)
    public Integer count;

}

사진을 보면 PARENT_NAME열은 열간에 "GroupA"라는 같은 항목을 가지지만 PARENT 열의 영향을 받아서 범위가 정해집니다.

그룹예제 C

다른 Group이 3개 이상일 경우

public class Inventory {

    @ExcelColumn(name = "PARENT", group = 2, index = 0, cellColor = IndexedColors.GREY_50_PERCENT)
    public String parentGroup;

    @ExcelColumn(name = "PARENT_NAME", group = 2, index = 1, cellColor = IndexedColors.GREY_50_PERCENT)
    public String parentGroupName;

    @ExcelColumn(name = "CHILD", group = 1, index = 2, cellColor = IndexedColors.GREY_25_PERCENT)
    public String childGroup;

    @ExcelColumn(name = "NAME", index = 3)
    public String name;

    @ExcelColumn(name = "COUNT", index = 4)
    public Integer count;

}

사진을 보면 CHILD열은 4행과 5행이 "B`"라는 값으로 연결되지만 앞선 그룹에 의해서 분리됩니다.

@UniqueKey & @UniqueKeys

엑셀 내부에 유니크를 보장해야 하는 항목에 대해서 유니크를 검증하는 Validation 작업을 지원합니다.

Excel <-> Object 변환 작업을 우선 진행하고 @UniqueKey or @UniqueKeys 관련 어노테이션을 가지고 있을 때

Unique Validation 작업을 진행합니다.

@UniqueKey
- values (String[])
@UniqueKeys
- values (UniqueKey[])
- objectKeyIndex (int) - default : 0

Single Key (싱글키)

하나의 항목이 Unique를 보장해야 할 때

@UniqueKey("name")
public class Inventory {

    @ExcelColumn(name = "NAME", index = 0)
    public String name;

    @ExcelColumn(name = "COUNT", index = 1)
    public Integer count;

}

Composite Key (복합키)

두 가지 이상의 항목을 결합했을 때 Unique를 보장해야 할 떄

@UniqueKey({"parentGroup", "childGroup"})
public class Inventory {

    @ExcelColumn(name = "PARENT", group = 2, index = 0)
    public String parentGroup;

    @ExcelColumn(name = "PARENT_NAME", group = 2, index = 1)
    public String parentGroupName;

    @ExcelColumn(name = "CHILD", group = 1, index = 2)
    public String childGroup;

    @ExcelColumn(name = "NAME", index = 3)
    public String name;

    @ExcelColumn(name = "COUNT", index = 4)
    public Integer count;

}

Multiple Key (중복키)

각각의 항목 별로 Unique를 보장해야 할 때

Multiple Single Key

@UniqueKeys({
	@UniqueKey("name"),
    @UniqueKey("count")
})
public class Inventory {

    @ExcelColumn(name = "NAME", index = 0)
    public String name;

    @ExcelColumn(name = "COUNT", index = 1)
    public Integer count;

}

Multiple Composite Key

@UniqueKeys({
	@UniqueKey({"parentGroup", "parentName"}),
    @UniqueKey({"parentGroup", "parentNo"})
})
public class Inventory {

    @ExcelColumn(name = "PARENT", group = 2, index = 0)
    public String parentGroup;

    @ExcelColumn(name = "P_NAME", group = 2, index = 1)
    public String parentName;

    @ExcelColumn(name = "P_NO", group = 1, index = 2)
    public Integer parentNo;

    @ExcelColumn(name = "NAME", index = 3)
    public String name;

    @ExcelColumn(name = "COUNT", index = 4)
    public Integer count;

}

Select InstanceKey in Multiple Key

@UniqueKeys(value = {
	@UniqueKey({"parentGroup", "parentName"}),
    @UniqueKey({"parentGroup", "parentNo"})
}, objectKeyIndex = 0)