Shell Script 전체 코드

#! /usr/bin/env bash

hosts = (a.example.com b.example.com)
LOG = "access.log"
pattern = "ERROR|WARN"

for host in $hosts
do
    if [ -z $pattern ]; then
        ssh deploy@$host "tail -F $LOG" | awk -v server=$host '{print "["server"]", $0}' &
    else
        ssh deploy@$host "tail -F $LOG" | awk -v server=$host -v pattern=$pattern '$0~pattern {print "["server"]", $0}' &
    fi
done

trap "ps | grep ssh | grep $LOG | awk '{print \$1}' | xargs kill -9" INT
wait

명령어

각 명령어에 대한 자세한 설명은 생략하고 간단하게 나열합니다.


tail

ssh deploy@$host "tail -F $LOG" &

원격 서버에 명령어를 전달하려면 ssh deploy@$host "{command}" 형태로 사용합니다.

명령어의 끝에 & 을 붙여서 모든 tail 명령어를 백그라운드에서 실행시키고 출력값만 현재 쉘에서 모아서 봅니다.


awk

awk -v server=$host '{print "["server"]", $0}'

여기서 awk 명령어는 tail 로 출력되는 로그들을 특정 포맷으로 감싸서 재출력하는 기능을 합니다.

-v 옵션은 awk action 에 특정 변수를 넘겨주고 싶을 때 사용하고 $0 은 레코드 전체를 의미합니다.

awk -v server=$host '{print "["server"]", $0}' 은 로그들을 [a.example.com] 로그내용~ 으로 변환해서 출력해줍니다.

로그들이 여러개 쌓이면 어디 서버에서 발생한 건지 알수 없기 때문이죠


awk (filter)

awk -v server=$host -v pattern=$pattern '$0~pattern {print "["server"]", $0}'

ERROR 또는 WARN 로그만 보고 싶을 수도 있습니다.

정규표현식 ~ 오퍼레이터를 사용하여 레코드 전체 ($0) 에서 정규표현식 $pattern 이 포함되어 있는 경우에만 출력하도록 필터를 걸었습니다.

처음에는 grep 명령어를 사용했으나 속도가 너무 느려서 실시간 전달이 안되고 로그가 뚝뚝 끊겨서 전달되어 보기 굉장히 불편했습니다.


trap & wait

trap "ps | grep ssh | grep $LOG | awk '{print \$1}' | xargs kill -9" INT
wait

& 기호를 붙여 백그라운드에서 실행했기 때문에 로그를 그만 볼때 모든 프로세스를 한번에 종료시켜야 합니다.

trap <handler> <signal> 은 특정 시그널을 받았을 때 handler 를 실행시키는 명령어입니다.

wait 은 자식 프로세스가 종료될 때까지 대기합니다.

즉, 위 코드는 실행한 쉘 스크립트를 대기 시켰다가 Ctrl + C 시그널을 받았을 때 백그라운드 프로세스를 모두 kill 합니다.

wait 명령어를 넣지 않으면 스크립트를 실행한 후에 전달할 시그널이 애매합니다.

그리고 로그 보고 있을 거니까 부모 프로세스를 굳이 조작할 필요도 없습니다.


Reference

에러 로그

TransientPropertyValueException: object references an unsaved transient instance - save the transient instance before flushing

원인

JPA 연관 관계 테스트 중에 발생했습니다.

FK 로 사용되는 컬럼값이 없는 상태에서 데이터를 넣으려다 발생한 에러입니다.

예를 들어 Person (id, name) 이라는 테이블과 House (id, address, person_id) 라는 테이블 관계가 있을 때, Person 데이터를 넣지 않고 House 데이터를 넣으려고 하면 person_id 값이 없어서 에러가 발생합니다.

Person person = new Person("Alice");
House house = new House("Seoul", person);

houseRepository.save(house);    // 에러 발생 (person 의 id 값을 모르는데 테이블에 넣으려고 해서)

해결 방법

연관 관계 매핑해줄 때 사용하는 @ManyToOne, @OneToOne, @OneToMany 어노테이션에 cascade 옵션을 설정해줍니다.

cascade 는 "영속성 전이" 라고 하는 개념인데 특정 엔티티를 영속화 할 때 연관된 엔티티도 함께 영속화 합니다.

저장할 때만 사용하려면 cascade = CascadeType.PERSIST 로 설정해주면 되며, 전체 적용인 CascadeType.ALL 로 설정해도 됩니다.

그럼 House 데이터를 저장하기 전에 Person 값부터 저장합니다.


Reference

Overview

쉘 스크립트 파일을 보면 파일 최상단에 #!/usr/bin/env bash 가 있는 걸 많이 봤을겁니다.

잘 모를때는 그냥 주석으로 실행 환경을 의미하는 건 줄 알았는데 사실은 굉장히 중요한 문장이었습니다.


1. SheBang (#!)

우선 #! 은 주석이 아니라 이 자체가 하나의 기호입니다.

어원은 위키피디아에 의하면 어원은 Hash(#) 또는 Sharp(#) 과 Bang(!) 의 합성어에서 유래한 것 같다고 합니다.

#! 은 2 Byte 의 매직 넘버 (Magic Number) 로 스크립트의 맨 앞에서 이 파일이 어떤 명령어 해석기의 명령어 집합인지를 시스템에 알려주는 역할을 합니다.

#! 바로 뒤에 나오는 것은 경로명으로, 명령어들을 해석할 프로그램의 위치를 나타냅니다.

가장 일반적으로 사용되는건 #!/bin/bash 이며 앞으로 나올 명령어들을 주석을 제외하고 순서대로 실행시킵니다.

만약 경로가 정확하지 않다면 bad interpreter 가 발생하고 다른 인터프리터를 지정하면 문법 오류로 실패합니다.


1.1. 문법

#!<interpreter> [optional-arg]

문법은 위와 같으며 #! 뒤에 공백 (Space) 이 하나 있어도 동작합니다.

<Interpreter> 에는 프로그램의 절대경로가 입력되어야 합니다.


1.2. 예시

#!/bin/sh
#!/bin/bash
#!/usr/bin/pwsh
#!/usr/bin/env python3

2. #!/usr/bin/env 란?

위 설명에서 <interpreter> 에는 프로그램의 절대 경로가 와야 한다고 했습니다.

하지만 절대경로는 시스템에 따라 달라질 수도 있습니다.

파이썬을 예로 들면 시스템에 따라 /bin/local/python 또는 /usr/bin/python 에 위치할 수도 있고 버전 또한 python2 와 python3 둘다 설치되어 있을 수 있습니다.

이럴 때 #!/usr/bin/env 로 설정하면 절대경로에 상관 없이 인터프리터의 위치를 찾아서 실행해줍니다.

그러니 여러 환경에서 실행되야할 스크립트라면 #!/usr/bin/env 를 사용하는 게 좋습니다.


3. Test

간단하게 테스트를 해봅시다.

터미널을 켜서 vi test 로 파일 하나를 작성합니다.

#! /usr/bin/env bash

echo "Hello This is Bash"

위 파일에 실행 권한을 추가하고 실행하면 정상적으로 동작합니다.

# 권한 추가
$ chmod +x test

# 실행
$ ./test
Hello This is Bash

이번엔 다시 파일을 열어 인터프리터를 파이썬으로 지정합니다.

#! /usr/bin/env python

echo "Hello This is Bash"

권한은 아까 주었으니 다시 파일만 실행시키면 에러가 발생합니다.

파이썬 문법에 맞지 않아 오류가 발생한 겁니다.

$ ./test
  File "./test", line 3
    echo "Hello This is Bash"
                            ^
SyntaxError: invalid syntax

다시 파일을 열어 파이썬 문법으로 고쳐줍시다.

#! /usr/bin/env python

print "Hello This is Python"

파일을 실행시키면 정상적으로 실행됩니다.

$ ./test
Hello This is Python

Conclusion

SheBang(#!) 문법은 스크립트 파일에서 어떤 프로그램으로 해당 파일을 실행시킬 지 결정합니다.

#!/usr/bin/env 를 사용하면 인터프리터의 절대 경로를 지정하지 않아도 알아서 경로를 찾아주기 때문에 여러 시스템 환경에서 사용할 때 유용합니다.

테스트를 보면서 알 수 있었던 한가지 특징은 확장자를 입력하지 않아도 #! 으로 인터프리터를 지정하면 정상적으로 실행된다는 사실입니다.


Reference

Overview

최근에 Mac OS 를 BigSur 로 업그레이드 하면서 데이터를 초기화 했습니다.

거의 2년 넘게 사용하던 설정들이 다 초기화 돼서 하나씩 설정했는데 다음에 또 세팅할 일이 생기면 볼 수 있게 기록해둡니다.


1. 환경설정

    1. 트랙패드 탭해서 클릭
    1. 트랙패드 세손가락으로 드래그](#12-트랙패드-세손가락으로-드래그)
    1. 마우스 가속도 끄기
    1. ₩ 를 ` 로 입력하게 바꾸기
    1. Mac 에서 한글 입력이 잘 안되는 현상
    1. 화면 Zoom in 기능

1.1. 트랙패드 탭해서 클릭

맥북은 기본적으로 꾹 눌러서 클릭하는데 위 설정을 키면 손가락 한번 탭한 것으로 클릭 가능합니다.

더블 클릭도 마찬가지로 두번 탭하면 됩니다.


1.2. 트랙패드 세손가락으로 드래그

환경설정 > 손쉬운 사용 > 포인터 제어기 > 트랙패드 옵션 에 들어가서 활성화 가능합니다.

아이콘, 이미지 등을 드래그 할 때 꾹 누르는 대신 세 손가락으로 쉽게 드래그 가능합니다.


1.3. 마우스 가속도 끄기

# 현재 감도 확인
defaults read .GlobalPreferences com.apple.mouse.scaling

# 새로운 감도 지정 (-1 로 설정하면 끄기)
defaults write .GlobalPreferences com.apple.mouse.scaling -1

기본적으로 마우스 가속도가 켜져 있는데 저는 불편해서 끄는 편입니다.

인텔 맥북에서만 가능하고 M1 맥북에서는 별도의 툴을 다운받아야 한다고 하네요.


1.4. ₩ 를 ` 로 입력하게 바꾸기

BigSur OS 로 업그레이드 하고 나니 한글 상태에서 1 왼쪽에 있는 키가 ` (백틱) 대신 로 입력되어 마크다운이나 코드블럭을 작성할 때 불편했습니다.

https://ani2life.com/wp/?p=1753 포스트를 참고하여 키 설정 변경 후 각 애플리케이션들을 새로 시작하면 각각 적용됩니다.

# KeyBindings 디렉토리 생성
$ mkdir ~/Library/KeyBindings

# DefaultkeyBinding.dict 생성 및 편집
$ vi ~/Library/KeyBindings/DefaultkeyBinding.dict

# 아래 내용 추가
{
    "₩" = ("insertText:", "`");
}

1.5. Mac 에서 한글 입력이 잘 안되는 현상

개인적인 이슈였을 수도 있는데, 맥북 에디터에서 한글을 입력하면 자음이나 모음 한두개가 입력되지 않고 씹히는 현상을 겪었습니다.

환경설정 > 키보드 > 입력 소스 로 이동해서 "삭제 방식" 을 "글자" 로 변경하면 해결됩니다.

변경 후에는 백스페이스로 글자를 지울 때 자음, 모음 단위로 안 지워지고 무조건 문자 단위로 지워지는데 크게 불편한 점은 못느끼고 있습니다.


1.6. 화면 Zoom in 기능

Control + 마우스 스크롤 로 화면을 확대할 수 있습니다.


2. 유용한 앱들

다음은 제가 맥북에서 사용하는 앱들입니다.

    1. iShot
    1. itsycal
    1. Rectangle
    1. AppCleaner
    1. Notion
    1. Spark
    1. Amphetamine
    1. Visual Studio Code

2.1. iShot

App Store 에서 다운 받을 수 있는 화면 캡쳐 프로그램입니다.

실행만 하면 option + A 조합으로 별다른 설정 없이 바로 사용할 수 있습니다.

전체화면, 특정 창, 드래그, 스크롤 캡쳐 등 다양한 기능을 제공하고 캡쳐한 사진을 바로 편집해서 복사, 저장할 수 있습니다.


2.2. itsycal

https://www.mowglii.com/itsycal/ 에서 다운로드 하거나 brew install --cask itsycal 명령어로 설치할 수 있습니다.

맥북은 달력 보기가 굉장히 불편해서 하나 설치해서 보면 좋습니다.

맥 캘린더랑 연동도 되는 것 같은데 달력 보는 용도 외에는 사용해본 적 없는거 같네요.


2.3. Rectangle

https://rectangleapp.com/ 에서 직접 다운받아 사용 가능합니다.

윈도우에서는 기본으로 제공되는 화면 분할이 맥에서는 없기 때문에 별도의 앱이 필요합니다.

control + option + @ 의 조합으로 사용할 수 있으며 생각한것보다 굉장히 유용합니다.

더블 모니터를 사용하는 경우에는 서로 이동도 돼서 마우스 사용 빈도가 낮아졌습니다.


2.5. AppCleaner

앱 지울 때 사용하기 위해 다운 받습니다.


2.6. Notion

https://www.notion.so/desktop 에서 다운가능합니다.

업무용, 개인용으로도 사용하기 굉장히 좋은 메모 앱입니다.

Mac OS, Window, Mobile 전부 호환 돼서 편리합니다.


2.7. Spark

맥북 기본 메일앱이 마음에 안들어서 App Store 에서 다운 받았습니다.

기본 앱은 메일을 받아도 노티가 오래 걸렸는데 스파크는 속도가 빨라서 유용하게 사용하고 있습니다.


2.8. Amphetamine

App Store 에서 다운 가능한 잠자기 방지 앱입니다.

원래는 환경 설정에서 화면 보호기 없는걸로 세팅했었는데 이 앱을 사용하면 좀더 여러 가지 설정이 가능합니다.

저는 그냥 항상 깨움 상태로 사용합니다.


2.9. Visual Studio Code

유용한 에디터이며 공식 홈페이지에서 다운 가능합니다.

개발용으로도 많이 쓰지만 저는 JetBrain 제품을 사용하기 때문에 마크다운 에디터로만 사용하고 있습니다.

설치한 확장팩

  • Markdown All in One : Markdown 작성 도와주는 확장팩
  • Markdown Preview Enhanced : Markdown Github 스타일로 미리보기 가능
  • Material Icon Theme : 그냥 아이콘이 이뻐보여서..
  • One Dark Pro : 그냥 테마
  • Paste Image (by mushan) : 클립보드 이미지를 붙여넣을 때 자동으로 이미지 파일이 생성되게 도와줌
    • Paste Image: Path 설정을 ${currentFileDir}/images 으로 변경
    • Paste Image: Default Name 설정을 Y_MM_DD_HH_mm_ss 으로 변경
    • Paste Image: Name Prefix 설정을 screen_ 으로 추가

1. Hack Font 설치

개인적으로 가장 선호하는 폰트입니다.

https://sourcefoundry.org/hack/#download 에서 Mac OS Zip 을 다운받고 풀어서 ttl 파일들을 실행시면 서체를 다운받을 수 있습니다.


2. Iterm2 설치

Iterm2 은 기본 터미널 애플리케이션보다 다양한 기능과 테마가 탑재된 보조 터미널 애플리케이션입니다.

공식 홈페이지 에서 설치하거나 Homebrew 로 설치 가능합니다.

$ brew install --cask iterm2

설치 후에는 Preference > Profiles > Text 로 이동해서 폰트를 변경할 수 있습니다.



2.1. Iterm2 테마 변경 (Dracula)

$ git clone https://github.com/dracula/iterm.git

위 명령어로 Dracula 테마를 아무 위치에나 다운 받습니다.

다운 받은 폴더에 들어가 Dracula.itermcolors 파일 더블클릭 하면 자동으로 테마가 추가됩니다.

Iterm2 > Perferences > Profiles > Colors > Color Presets... 로 가서 Dracula 를 선택합니다.



2.2. 한글 깨짐 수정



3. Oh My ZSH 설치

Oh My Zsh 는 기본 쉘보다 더 다양한 기능을 제공하는 Z Shell 의 플러그인입니다.

Catalina OS 부터 zsh 가 기본 터미널이 되었기 때문에 따로 설치할 필요는 없고 플러그인만 설치하면 됩니다.

https://github.com/ohmyzsh/ohmyzsh 를 참고해서 설치 가능합니다.

# ohmyzsh curl 설치
$ sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"



3.1. zsh 테마 적용

agnoster 가 국룰인것 같은데 저는 powerlevel10k 테마를 적용했습니다.

# zsh 테마에 powerlevel10k 추가
$ git clone https://github.com/romkatv/powerlevel10k.git ~/.oh-my-zsh/themes/powerlevel10k

# .zshrc 파일 수정
$ vi ~/.zshrc

ZSH_THEME="powerlevel10k/powerlevel10k"

# 변경한 .zshrc 적용하면 여러 가지 설정 Step 이 나오고 다 선택하면 최종 적용됨
$ source ~/.zshrc

3.2. Syntax Highlighting 플러그인 적용

존재하지 않은 명령어를 입력하면 빨간색으로 알려주는 편리한 플러그인입니다.

존재하는 명령어는 녹색으로 표시됩니다.

# 설치
$ brew install zsh-syntax-highlighting

# 적용 (.zshrc 맨 밑에 추가해야 터미널을 껐다 켜도 적용됨)
# 환경에 따라 zsh 파일 위치가 다를 수 있으므로 설치 후 터미널 가이드 참고
$ source /opt/homebrew/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh

3.3. 자동완성제안 (Auto Suggestions) 플러그인 적용

과거에 입력한 명령어를 자동으로 만들어주는 기능입니다.

이미 입력해본 적이 있는 명령어라면 조금만 입력해도 위 사진처럼 가장 최근에 입력한 명령어를 보여줍니다.

이 상태에서 방향키 오른쪽 버튼을 누르면 전체 명령어를 완성해줍니다.

# 설치
$ brew install zsh-autosuggestions

# 적용 (.zshrc 맨 밑에 추가해야 터미널을 껐다 켜도 적용됨)
# 환경에 따라 zsh 파일 위치가 다를 수 있으므로 설치 후 터미널 가이드 참고
source /opt/homebrew/share/zsh-autosuggestions/zsh-autosuggestions.zsh

3.4. autojump 플러그인 추가

# 설치
brew install autojump

# .zshrc 수정
plugins=(git autojump)

과거에 방문했던 위치를 적당히 힌트만 주면 알아서 찾아줍니다.

예를 들어 위 사진 처럼 /Downloads 에서 j study 를 입력하면 study 라는 이름을 가진 디렉토리 중 가장 많이 방문한 곳으로 이동합니다.

j -s 명령어로 방문한 디렉토리 기록도 확인 가능합니다.

Overview

compile 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.springframework.boot:spring-boot-starter-web'

testCompile 'org.springframework.boot:spring-boot-starter-test'
testImplementation 'org.springframework.boot:spring-boot-starter-test'

build.gradle 에 관한 설정을 검색하다보면 의존 라이브러리를 추가할 때 두가지 방법을 자주 봅니다.

compileimplementation 은 무슨 차이가 있을까요?


1. compile 은 상위 모듈까지 가져온다

compileimplementation 보다 더 많은 라이브러리를 빌드합니다.

예를 들어 다음과 같이 의존하는 관계의 프로젝트 세 개가 있다고 가정합니다.

myApp -> mySpring -> myJava

myApp 에서 mySpring 을 의존하고 mySpring 은 myJava 를 의존합니다.

이 때 compile 을 사용해서 mySpring 을 빌드하게 되면 mySpring 이 의존하고 있는 myJava 까지 함께 빌드합니다.

그래서 myApp 에서 myJava 모듈이 제공하는 API 까지 사용할 수 있습니다.

만약 myJava 를 직접적으로 사용할 필요가 없다면 필요하지 않은 API 들이 노출되고 빌드 시간도 오래 걸리기 때문에 비효율적인 행동이 됩니다.

대신 implementation 을 사용해서 빌드하면 mySpring 모듈만 가져오기 때문에 빌드 속도가 빠르고 필요한 API 만 노출해서 사용할 수 있습니다.


2. compile 은 deprecated 되었다

그리고 compile 은 deprecated 되고 api 로 대체되었습니다.

그러니 만약 상위 모듈까지 전부 가져오고 싶을 땐 compile 대신 api 를 사용하면 됩니다.

일반적인 경우에는 implementation 을 사용해서 빌드 속도를 향상시키는 것이 좋습니다.


Conclusion

  • implementation 은 지정한 모듈만 가져오고 compile, api 는 상위 모듈까지 전부 가져옵니다.
  • compile 은 deprecated 되었고 대신 api 를 사용하면 됩니다.
  • 일반적인 상황에서는 빌드 속도가 빠르고 필요한 모듈만 가져오는 implementation 을 사용하면 됩니다.

Reference

1. Overview

Java Enum 에 이어 Kotlin Enum 사용법에 대해서도 알아봅니다.

사용법과 이유에 대해서는 Java 에서 알아보았으니 간단하게 코드만 작성합니다.


2. 기본 사용법

enum class Day {
    MON, TUE, WED, THU, FRI, SAT, SUN
}

3. 필드값 추가

enum class Day(
    val label: String
) {
    MON("Monday"),
    TUE("Tuesday"),
    WED("Wednesday"),
    THU("Thursday"),
    FRI("Friday"),
    SAT("Saturday"),
    SUN("Sunday")
    ;
}

Kotlin 은 원래 ; 을 안쓰지만 Enum 클래스에 필드값을 추가하는 경우 마지막에 꼭 추가해야합니다.


4. 필드값 캐싱

enum class Day(
    val label: String
) {
    MON("Monday"),
    TUE("Tuesday"),
    WED("Wednesday"),
    THU("Thursday"),
    FRI("Friday"),
    SAT("Saturday"),
    SUN("Sunday")
    ;

    companion object {
        private val LABEL_CACHE: Map<String, Day> =
            values().associateBy { it.label }

        fun findByLabel(label: String) = LABEL_CACHE[label]
    }
}

5. 상수별 메소드 구현

enum class Operation {
    PLUS {
        override fun apply(x: Double, y: Double): Double {
            return x + y
        }
    },

    MINUS {
        override fun apply(x: Double, y: Double): Double {
            return x - y
        }
    },

    TIMES {
        override fun apply(x: Double, y: Double): Double {
            return x * y
        }
    },

    DIVIDE {
        override fun apply(x: Double, y: Double): Double {
            return x / y
        }
    };

    abstract fun apply(x: Double, y: Double): Double
}

Reference

1. Overview

Java Enum 1편 : Enum 기본적인 사용에 대해서는 이미 학습했습니다.

이번에는 Enum 에 메소드를 추가하여 원하는 동작을 만들어내는 방법과 그밖의 활용법을 알아봅니다.


2. 메소드 추가 1: Enum 상수 별로 다른 동작이 필요할 때

가장 쉽게 떠올릴 수 있는 방법은 switch 문입니다.

하지만 Enum 클래스에는 상수별 메소드 구현 (Constant-specific Method Implementation) 이라는 좀더 깔끔한 방법이 있습니다.


2.1. Before

public enum Operation {
    PLUS, MINUS, TIMES, DIVIDE;

    // 상수가 뜻하는 연산을 수행한다.
    public double apply(double x, double y) {
        switch (this) {
            case PLUS: return x + y;
            case MINUS: return x - y;
            case TIMES: return x * y;
            case DIVIDE: return x / y;
        }
        throw new AssertionError("알 수 없는 연산: " + this);
    }
}
  • 깔끔해보이지만 뭔가 아쉬움
  • 마지막 AssertionError 는 실제로는 도달하지 기술적으로는 도달 가능하기 때문에 생략 불가능
  • 새로운 상수를 추가하면 case 문도 추가해야함

2.2. After

public enum Operation {
    PLUS   { public double apply(double x, double y) { return x + y; }},
    MINUS  { public double apply(double x, double y) { return x - y; }},
    TIMES  { public double apply(double x, double y) { return x * y; }},
    DIVIDE { public double apply(double x, double y) { return x / y; }};

    public abstract double apply(double x, double y);
}
  • Enum 상수값 별로 다르게 동작하는 코드를 구현
  • apply 라는 추상 메소드를 선언하고 각 상수에서 재정의
  • 이를 상수별 메소드 구현 (constant-specific method implementation) 이라고 함
  • 추상 메소드로 정의되어 있기 때문에 새로운 상수를 추가해도 실수할 가능성이 적음

3. 메소드 추가 2: Enum 상수 일부가 같은 동작을 공유할 때

위에서 본 방법은 Enum 에 있는 각각의 상수가 모두 다른 동작을 할 때 사용했습니다.

만약 일부 상수끼리 같은 동작을 공유해야 할 때는 어떻게 해야 할까요?

일반적으로 생각 가능한 방법은 두가지가 있습니다.

  1. 상수별로 메소드를 구현해서 같은 동작 코드를 중복해서 넣는다.
  2. 별도의 메소드를 하나 만들어서 상수별 메소드에서 호출한다.

위 두가지 방법 모두 중복된 코드를 작성해야 한다는 단점이 있습니다.

다행히 Enum 클래스에서는 이러한 상황에서 전략 열거 타입 (Enum) 이라는 방법이 있습니다.


3.1. Before

public enum Fruit {
    APPLE, ORANGE, BANANA, STRAWBERRY;

    public void printColor() {
        switch (this) {
            case APPLE:
            case STRAWBERRY:
                System.out.println("This is Red");
                break;
            default:
                System.out.println("This is Not Red");
        }
    }
}
  • 과일을 나타내는 Fruit Enum 클래스
  • printColor() 메소드를 호출하면 빨간색 과일들과 나머지 과일들의 출력 결과문이 다름
  • 위의 문제점과 마찬가지로 새로운 빨간색 과일을 추가했을 때 switch 문에도 추가하지 않으면 빨간색 과일인데 "This is Not Red" 가 출력됨

3.2. After

public enum Fruit {
    APPLE(ColorType.RED),
    ORANGE(ColorType.OTHER),
    BANANA(ColorType.OTHER),
    STRAWBERRY(ColorType.RED);

    private final ColorType colorType;

    Fruit(ColorType colorType) {
        this.colorType = colorType;
    }

    public void printColor() {
        colorType.printColor();
    }

    enum ColorType {
        RED {
            void printColor() {
                System.out.println("This is Red");
            }
        },
        OTHER {
            void printColor() {
                System.out.println("This is Not Red");
            }
        };

        abstract void printColor();
    }
}
  • Fruit Enum 클래스 내부에 ColorType 이라는 Inner Enum 클래스를 정의
  • printColor() 의 동작을 ColorType 에 위임
  • 새로운 빨간색 과일이 추가되더라도 ColorType 을 지정해야 하므로 실수할 일이 적음

4. 메소드 추가 3: 여러 상수별 동작이 혼합될 때

한 Enum 상수값의 동작에 다른 Enum 상수값이 필요하다면 그냥 switch 문을 쓰는 것이 좋습니다.

public enum Direction {
    NORTH, EAST, SOUTH, WEST;

    public static Direction rotate(Direction dir) {
        switch (dir) {
            case NORTH: return EAST;
            case EAST:  return SOUTH;
            case SOUTH: return WEST;
            case WEST:  return NORTH;
        }
        throw new AssertionError("알 수 없는 방향: " + dir);
    }
}

5. ordinal 메서드 대신 인스턴스 필드를 사용하라

Enum 클래스에는 기본적으로 ordinal 이라는 메소드를 제공합니다.

0 부터 시작되며 특정 상수값의 위치 (Index) 를 리턴해줍니다.

Enum API 문서를 보면 ordinal 에 대해서 이렇게 쓰여 있습니다.

"대부분의 개발자는 이 메소드를 쓸 일이 없다. 이 메소드는 EnumSetEnumMap 같이 열거 타입 기반 범용 자료구조에 쓸 목적으로 설계되었다."

oridnal 을 사용할 때의 단점은 여러 가지 있습니다.

  • 나중에 추가될 Enum 상수값이 꼭 순서대로라는 보장이 없다
  • 중복된 숫자를 가져야 할 때 구분이 불가능하다

그러므로 ordinal 메소드를 사용하지 말고 별도의 인스턴스 필드를 선언해서 사용합시다.


6. ordinal 인덱싱 대신 EnumMap 을 사용하라

Enum 값을 Index 로 사용하고 싶을 때 배열 + ordinal 을 사용하는 것보다 EnumMap 을 사용하는 것이 좋습니다.

EnumMap 도 내부적으로 ordinal 을 사용하기 때문에 성능 상의 차이도 없습니다.

위에서도 한번 언급했었지만 개발자가 직접 ordinal 을 쓸 상황은 없습니다.


7. 비트 필드 대신 EnumSet 을 사용하라

과거에는 여러 값들을 집합으로 사용해야 할 경우 비트로 사용했습니다.

public class Text {
    public static final int STYLE_BOLD          = 1 << 0;   // 1
    public static final int STYLE_ITALIC        = 1 << 1;   // 2
    public static final int STYLE_UNDERLINE     = 1 << 2;   // 4
    public static final int STYLE_STRIKETHROUGH = 1 << 3;   // 8

    // 매개변수 styles 는 0 개 이상의 STYLE_ 상수를 비트별 OR 한 값
    public void applyStyles(int styles) {
        // ...
    }
}

// usage
text.applyStyles(STYLE_BOLD | STYLE_ITALIC);
  • 여러 개의 상수값을 OR 하여 사용하면 집합을 나타낼 수 있음
  • 이렇게 만들어진 집합을 비트 필드 (bit field) 라고 함
  • 비트 필드 값은 해석하기 어려움
  • 최대 몇 비트가 필요한지 API 작성 시 미리 예측하여 적절합 타입 (int, long) 을 선택해야 함

7.1. EnumSet 클래스

public class Text {
    public enum Style { BOLD, ITALIC, UNDERLINE, STRIKETHROUGH }

    public void applyStyles(Set<Style> styles) {
        // ...
    }
}

// usage
text.applyStyles(EnumSet.of(Text.Style.BOLD, Text.Style.ITALIC));
  • java.util 패키지
  • Set 인터페이스를 구현하며, 타입 안전하고, 다른 어떤 Set 구현체와도 함께 사용 가능
  • EnumSet 내부는 비트 벡터로 구현됨

Reference

+ Recent posts