모듈화를 함에 있어서 UML이 무엇인지, UML을 이용해 클래스 다이어그램을 작성하는 방법을 공부하기 위한 포스팅이다.

  • UML(Unified Modeling Language)
    • 시스템을 모델로 표현해주는 대표적인 모델링 언어.
  • UML 다이어그램의 종류
    1. 구조 다이어그램
      • 클래스 다이어그램, 객체 다이어그램, 복합체 구조 다이어그램, 배치 다이어그램, 컴포넌트 다이어그램, 패키지 다이어그램.
    2. 행위 다이어그램
      • 활동 다이어그램, 상태 머신 다이어그램, 유즈 케이스 다이어그램, 상호작용 다이어그램.
  • UML 작성 도구

클래스 다이어그램이란

  • 시간에 따라 변하지 않는 시스템의 정적인 면을 보여주는 대표적인 UML 구조 다이어그램이다.
  • 목적 : 시스템을 구성하는 클래스들 사이의 관계를 표현한다.

클래스

  • 클래스란
    1. 동일한 속성과 행위를 정의한 객체의 집합.
    2. 객체를 생성하는 설계도.
  • 클래스는 변화의 기본 단위
    • 디자인 패턴을 제대로 이해하려면 만들진 프로그램을 흔들어보고 어떤 것이 변화되는지를 잘 살펴봐야 한다.
  • UML 클래스의 표현은 아래 그림과 같다.
    • 가장 위 : 클래스 이름
    • 중간 : 속성(클래스의 특징, 변수)
    • 마지막 : 연산(클래스가 수행하는 책임, 메소드)
    • 경우에 따라 속성과 연산 부분은 생략 가능.
  • 속성과 연산의 가시화를 정의
    • UML에서는 접근 제어자를 사용해 나타낼 수 있다.
  • 분석 단계와 설계 단계에서의 클래스 다이어그램은 아래와 같다.
    • 분석 단계는 조금 더 간략하게 표시한다.
    • 설계 단계는 보다 더 세밀하게 작성한다.

관계

UML에서 제공하는 클래스들 사이의 관계는 아래의 표와 같다.
표를 먼저 보고 각 관계의 의미에 대해서 알아보도록 하자.

서로 의미있는 클래스들의 관계에는 크게 4가지 종류가 있다.
일반적인 의미의 연결 관계인 연관(association) 관계, 전체와 부분을 나타내는 집합(aggregation) 관계, 다른 클래스의 속성을 물려받는 상속(inheritance) 관계, 그리고 한 클래스가 다른 클래스에 영향을 미치는 의존(dependency) 관계가 있다.

연관 관계와 의존 관계를 구분 짓는 가장 큰 기준은
참조하는 클래스 인스턴스의 참조를 계속 유지하고 있느냐, 아니냐이다.
아래의 코드에서 확인할 수 있다.

  • 연관 관계 : 참조를 유지한다.
  • 의존 관계 : 참조를 짧게 유지하고 빠르게 끊는다.

의존(dependency) 관계

  • 일반적으로 한 클래스가 다른 클래스를 사용하는 경우.
    1. 클래스의 속성에서 참조할 때
    2. 매개변수, 인자로 사용될 때
    3. 메소드 내부의 지역 변수로 참조될 때
  • 1 : 연관 관계 / 2,3 : 의존 관계
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
public class A {

public A(){
// 생성자.
}

public void callA(){
// 의존 관계 : 이 메소드 내부에서만 c의 참조를 유지한다.
// 메소드 실행이 종료되면 c의 참조도 사라진다.
C c = new C();
c.callC();
}
}

public class C {
// 생략.
}
  • 위의 코드에서 확인할 수 있는 것처럼 짧은 시간 동안 이용하는 관계
  • UML에서는 다음과 같이 점선으로 나타낸다.

연관 관계

  • 오랜 시간 동안 같이 할 객체와의 관계
  • 예를 들어, 자동차와 자동차를 소유한 사람의 관계
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
public class A {
private C c;

public A() {
// 생성자.
// 연관 : 클래스 C에 대한 참조를 계속 유지하고 있음.
this.c = new C();
}

public void callA(){
this.c.callC();
}
}

public class C {
// 생략.
}

의존 관계(dependency)

클래스가 연관, 상속, 집합 관계로 엮여 있는 것은 아니지만, 한 곳이 변경되면 그것을 사용하는 다른 곳도 같이 변경해줘야 하는 관계를 표현할 때 주로 사용한다. 주의해야 할 점은 연관 관계와 달리 의존 관계의 경우에는 클래스 인스턴스의 참조를 유지하고 있지 않다는 점이다. 참조를 계속적으로 유지하게 되면 이는 연관 관계로 표현해야 한다.

주로 다음과 같은 세 가지 경우에 의존 관계로 표현한다.

  1. 한 클래스의 메소드가 다른 클래스의 객체를 인자로 받아 그 객체의 메소드를 사용한다.(가장 일반적이다.)
  2. 한 클래스의 메소드가 또 다른 클래스의 객체를 반환한다.
  3. 다른 클래스의 메소드가 또 다른 클래스의 객체를 반환한다. 이때 이 메소드를 호출하여 반환되는 객체의 메소드를 사용한다.

연관 관계(association)

한 객체가 다른 객체와 연결되어 있음을 나타낼 때 그들을 연관 관계로 지칭한다. 이 연관 관계에서 중요하게 볼 점은 연관 관계의 방향멀티플리시티이다.

연관 관계는 방향성을 가지며 양방향과 단방향으로 구분지을 수 있다.

  • 단방향 연관 관계 : 한쪽은 알지만 다른 쪽은 상대방의 존재를 모른다.
    • 화살표로 표시한다.
    • 아래의 UML House 클래스는 Person 클래스의 존재를 알고 있지만, Person은 House 클래스의 존재를 모른다.
    • House 클래스만 Person 클래스에 대한 참조값을 가지고 있고, Person은 House에 대한 어떠한 참조값도 가지고 있지 않는다.
  • 양방향 연관 관계 : 연결된 클래스들이 서로의 존재를 알고 있다.
    • 실선으로 표시한다.
    • 아래의 UML의 의미는 House와 Person 클래스는 서로의 존재를 알고 있으며, 반드시 한 사람 이상이 House에 속해야 한다는 뜻이다.

다대다 연관 관계는 양방향 연관 관계로 표현되는 것이 적절하다. 하지만 양방향 연관 관계를 구현하는 것은 복잡하기 때문에 보통 다대다 연관 관계를 일대다 단방향 연관 관계로 변환해 구현한다. -> 연관 클래스

  • 연관 클래스
    • 연관 관계에 추가할 속성이나 행위가 있을 때 사용한다.
    • 연관 클래스를 일반 클래스로 변환
      • 연관 클래스는 연관 관계가 있는 두 클래스 사이에 위치하며, 점선을 사용해 연결한다.
      • 이 연관 클래스를 일반 클래스로 변환하여 다대다에서 일대다 연관 관계로 변환한다.

일반화 관계

  • 한 클래스가 다른 클래스를 포함하는 상위 개념일 때 두 클래스 사이에는 일반화 관계가 존재한다.
  • 객체지향 개념에서는 일반화 관계를 상속 관계(IS-A)라고 한다
  • 부모 클래스
    • 추상적인 개념이며 위의 그림에서 가전제품에 해당.
    • 자식 클래스에게 공통 속성이나 기능을 제공한다.
    • ex) 제조번호, 제조 회사 같은 공통 속성과 turnOn/Off 같은 공통 기능을 두고 자식 클래스에서 상속받아 구현할 수 있다.
  • 자식 클래스
    • 구체적인 개념이며 아래의 제품들에 해당.
  • 추상 클래스
    • 추상 메소드를 하나 이상 갖는 클래스
    • 추상 메소드
      • 부모 클래스에서 구현부 없이 선언부만 있는 함수
      • ex) turnOn/Off는 자식 클래스에서 구현함에 따라 달라지기 때문에 부모 클래스에서 추상 메소드로 선언한다.
    • 일반적인 클래스와 달리 객체를 생성할 수 없다.
  • UML에서의 표현
    • 이탤릭체 사용.

집합 관계

  • 연관 관계의 특별 경우로 전체와 부분의 관계를 명확하게 명시하고자 할 때 사용한다.
  • aggregation(집합)과 composition(구성)을 구분하는 기분은 lifeCycle이 같느냐, 같지 않느냐이다.
  • lifeCycle이란 클래스 인스턴스의 생명주기를 말하는 것으로 생성에서 소멸까지의 과정이다.
  1. 집합 관계(aggregation)
  • 한 객체가 다른 객체를 포함하는 것
    • 부분을 나타내는 객체를 다른 객체와 공유할 수 있다.
  • 전체를 가리키는 클래스 방향에 빈 마름모 표시
  • 전체 객체의 lifeCycle과 부분 객체의 lifeCycle은 독립적이다.
    • 즉, 전체 객체가 사라진다 해도 부분 객체는 사라지지 않는다.
  • 예시 : 생성자에서 참조값을 인자로 받아 필드 세팅
1
2
3
4
5
6
7
8
9
10
11
12
public class Computer{
private MainBoard mb;
private CPU c;

public Computer(MainBorad mb, CPU c){
this.mb = mb;
this.c = c;
// 집합 연관 : 부분과 전체의 관계
// 부분이 되는 객체를 외부에서 생성하여 넘겨 받는다.
// 따라서 Computer 클래스가 없어져도 부분이 되는 객체들은 사라지지 않는다.
}
}
  1. 합성 관계(Composition)
  • 부분 객체가 전체 객체에 속하는 관계
    • 부분을 나타내는 객체를 다른 객체와 공유할 수 없다.
  • 전체를 가리키는 클래스 방향에 채워진 마름모로 표시
  • 전체 객체의 lifeCycle과 부분 객체의 lifeCycle은 의존적이다.
    • 즉, 전체 객체가 없어지면 부분 객체도 없어진다.
  • 예시 : 생성자에서 필드에 대한 객체를 생성한다.
1
2
3
4
5
6
7
8
9
10
11
12
13
public class Computer{
private MainBoard mb;
private CPU c;

// 생성자
public Computer(){
this.mb = new MainBoard();
this.c = new CPU();
// 합성 : 집합 관계 중에서도 강한 집합체의 의미를 갖는다.
// 부분을 이루는 객체가 없이는 전체가 아무런 의미를 갖지 못한다.
// Computer 클래스가 사라져 버리면 내부에서 생성된 MainBoard, CPU도 같이 사라진다.
}
}

aggregation과 composition을 쉽게 설명하면 모자와 안경을 쓴 사람을 생각해보자. 이 사람을 구성하고 있는 요소에는 눈,팔,다리와 같이 사람이 죽으면 같이 없어지는 요소들이 있고, 안경,모자와 같이 바꿔 사용할 수 있는 요소들이 있다.

즉, 눈,팔,다리는 사람과 lifeCycle이 같은 Composition 관계이고 안경이나 모자는 Aggregation 관계인 것이다.

인터페이스와 실체화 관계

  • 인터페이스란
    • 책임이며, 어떤 객체의 책임이란 객체가 해야 하는 일 또는 객체가 할 수 있는 일이다.
    • 즉, 객체가 외부에 제공하는 서비스나 기능은 객체가 수행하는 책임으로 본다.
    • 공통되는 능력이 있는 것들을 대표하는 관점
  • UML에서의 인터페이스 표현
    • 빈 삼각형과 점선을 이용
  • 객체 지향 개념에서는 실체화 관계를 can do this 관계라고 한다.
1
2
3
4
5
6
7
8
9
10
public interface Flyable{
// 생략.
}

public class Plane implements Flyable{
// 생략.
}
public class Bird implements Flyable{
// 생략.
}

참고

Comment and share

좋은 객체지향 설계를 위해서 다음의 5가지 원칙을 따르는 것이 좋고, 이 원칙들을 기반으로 디자인 패턴이 되기 때문에 알아두면 확실하게 도움이 된다.
객체지향의 5대 원칙의 앞글자를 따서 SOLID라고 부르기도 한다.

1. SRP

  • SRP(Single Responsibility Principle)는 단일 책임 원칙이라고 한다.
  • 모든 클래스는 단 하나의 책임을 갖는다. 다시 말해서 클래스를 변경할 이유는 오직 하나여야 한다는 뜻이다.
  • 책임 영역이 확실해지기 때문에 한 책임의 변경에서 다른 책임의 변경으로의 연쇄 작용에서 자유로울 수 있다.
  • 책임을 적절히 분배함으로써 코드의 가독성 향상, 유지보수 용이의 이점이 생긴다.
  • 간단한 예를 들면, 계산기 클래스가 있을 때, 계산을 하는 책임과 GUI를 나타내는 책임은 서로 분리되어야 한다. 계산기 클래스에 GUI를 나타내는 부분까지 있을 경우, 이는 SRP를 위반한다.

Before Code

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// 현재 UserSettingService 클래스에는 두 개의 책임이 있다.
// 1. 변경
// 2. 접근 권한에 대한 부분
public class UserSettingService{

public void changeEmail(User user){
if(checkAccess(user)){
// do someting
}
}

public boolean checkAccess(User user){
// user check
}
}

After Code

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 현재 UserSettingService 클래스의 두 개의 책임을 둘로 나눈다.
// 1. 변경(UserSettingService.class)
// 2. 접근 권한에 대한 부분(SecurityService.class)
public class UserSettingService{

public void changeEmail(User user){
if(SecurityService.checkAccess(user)){
// do something.
}
}
}

public class SecurityService{

public static boolean checkAccess(User user){
// Check user access.
}
}

2. OCP

  • OCP(Open-Closed Principle)는 개방 폐쇄 원칙이라고 한다.
  • 기능을 확장하거나 변경하는 것에 대해서는 개방되어야 하지만, 수정에 대해서는 폐쇄되어야 한다.
  • 변경을 위한 비용은 가능한 줄이고 확장을 위한 비용은 가능한 극대화 해야 한다는 의미이다.
  • 요구사항의 변경이나 추가사항이 발생하더라도 기존 구성요소는 수정이 일어나지 말아야 하며, 기존 구성요소를 쉽게 확장해서 재사용할 수 있어야 한다는 뜻이다.
  • 중요 매커니즘은 추상화와 다형성이다.
  • 예를 들자면, 캐릭터를 하나 생성한다고 가정하자. 각각의 캐릭터가 움직임이 다를 경우 움직임의 패턴 구현을 하위 클래스에 맡긴다면 캐릭터 클래스의 수정은 필요없고(수정에 대해 폐쇄) 움직임의 패턴만 재정의하면 된다.(확장에 대한 개방)

OCP 원칙이 깨질 때의 주요 현상

  1. 다운 캐스팅을 한다.
1
2
3
4
5
6
7
8
public void drawCharacter(Character character){
if(character instanceof Missile){ // 타입 확인.
Missile missile = (Missile) character; // 다운 캐스팅.
missile.drawSpecific(); // 미사일일 경우 drawSpecific() 호출.
}else{
character.draw(); // 미사일 외의 경우는 draw() 호출.
}
}
  1. 비슷한 if-else 블록이 존재한다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
public class Enemy extends Character{
private int pathPattern;

public Enemy(int pathPattern){
this.pathPattern = pathPattern;
}

public void draw(){
if(pathPattern == 1){
x +=5;
y +=5;
}else if(pathPattern == 2){
x +=10;
y +=10;
}else if(pathPattern == 3){
x +=15;
y +=15;
}else{
x +=20;
y +=20;
}
}
}
  • OCP는 자주 사용되는 문법이 인터페이스라고 보면 된다.

Before Code

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 음악을 재생하는 클래스.
class SoundPlayer{

void play(){
System.out.print("play wav"); // wav 재생.
}
}

public class Client{
public static void main(String[] args){
SoundPlayer sp = new SoundPlayer();
sp.play();
}
}

SoundPlayer 클래스는 기본적으로 wav 파일을 재생할 수 있다. 하지만 다른 포맷의 파일, 예를 들어 mp3 파일을 재생하도록 요구사항이 변경된다면 어떻게 될까?

이 요구사항을 만족시키기 위해서 SoundPlayer 클래스의 play() 메소드를 수정해야 한다. 그러나 이와 같은 소스 코드 변경은 OCP 원칙에 위배되는 행위다.

인터페이스를 이용해 OCP 원칙을 지켜보자. 먼저 변해야 하는 것이 무엇인지 정의한다. 위의 예에서는 play() 메소드가 변해야 한다. 따라서 play() 메소드를 인터페이스로 분리한다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
interface playFile(){
public void play();
}

class Wav implements playFile(){
@Override
public void play(){
System.out.print("Play wav");
}
}

class Mp3 implements playFile(){
@Override
public void play(){
System.out.print("Play Mp3");
}
}

재생하고자 하는 파일 클래스(Wav, Mp3)를 만들어 playFile 인터페이스와 play() 메소드를 재정의하도록 설계한다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
class SoundPlayer{
private playFile file;

public void setFile(playFile file){
this.file = file;
}

public void play(){
this.play();
}
}

public class Client{

public static void main(String[] args){
SoundPlayer sp = new SoundPlayer();
sp.setFile(new Wav()); // 원하는 재생 파일 선택.
sp.serFile(new Mp3());
sp.play();
}
}

SoundPlayer 클래스에서는 playFile 인터페이스를 멤버 변수로 만든다. 그 후 SoundPlayer의 play() 함수는 인터페이스를 상속받아 구현된 클래스의 play() 함수를 실행시키게 한다. main() 함수에서 setFile() 함수를 이용해 우리가 재생하고자 하는 파일의 객체를 지정해준다.

이와 같은 설계를 디자인 패턴에서는 Strategy Pattern(전략 패턴)이라고 한다. 디자인 패턴은 추후에 공부할 필요가 있을 것 같다.

아무튼 결과적으로 SoundPlayer 클래스의 변경 없이 재생되는 파일을 바꿀 수 있으므로 위 코드는 OCP 원칙을 만족하게 된다. OCP 원칙을 적용한 설계는 변경에 유연하므로 유지보수 비용을 줄여주고 코드의 가독성 또한 높아지는 효과를 얻을 수 있다.

3. LSP

  • LSP(Liskov Substitution Priciple)는 리스코프 치환 원칙이라고 한다.
  • 상위 타입의 객체를 하위 타입의 객체로 치환해도 상위 타입을 사용하는 프로그램은 정상적으로 동작해야 한다.
  • 쉽게 말하면, 자식 클래스는 언제나 자신의 부모 클래스를 교체할 수 있다는 원칙이다. 즉, 부모 클래스와 자식 클래스 사이의 행위에는 일관성이 있어야 한다는 원칙이다.
  • 상속 관계에서는 일반화 관계(IS-A)가 성립해야 한다. 일반화 관계에 있다는 것은 일관성이 있다는 것이다. 따라서 리스코프 치환 원칙은 일반환 관계에 대해 묻는 것이라 할 수 있다.

이해를 돕기 위해 도형을 예로 하는 설명이 있다.
도형 클래스와 사각형 클래스가 있고, 사각형 클래스는 도형 클래스를 상속한다.

(1). 도형은 둘레를 가지고 있다.
(2). 도형은 넓이를 가지고 있다.
(3). 도형은 각을 가지고 있다.

일반화 관계(일관성인지 확인하는 방법은 단어를 교체해보면 알 수 있다. 도형 대신 사각형을 넣어보자.)

(1). 사각형은 둘레를 가지고 있다.
(2). 사각형은 넓이를 가지고 있다.
(3). 사각형은 각을 가지고 있다.

이상한 부분이 보이지 않는다. 따라서 도형과 사각형 사이에는 일관성이 있다고 할 수 있다.

그럼 원이라는 도형에 대해서 생각해보자. 원 클래스 역시 도형 클래스의 상속을 받는다고 가정하고 (1) ~ (3)의 도형 단어 대신 원을 대입해보자.

(1). 원은 둘레를 가지고 있다.
(2). 원은 넓이를 가지고 있다.
(3). 원은 각을 가지고 있다.

원의 경우에는 (3)번 문장이 어색하다는 것을 알 수 있다. 따라서 도형 클래스는 LSP 원칙을 만족하지 않는 설계라고 할 수 있다. (3) 문장에 대해서 일반화 관계가 성립하도록 수정되어야 한다.

4. ISP

  • ISP(Interface Segregation Priciple)는 인터페이스 분리 원칙이라고 한다.
  • 인터페이스는 그 인터페이스를 사용하는 클라이언트를 기준으로 분리해야 한다.
  • 즉, 자신이 사용하지 않는 기능(인터페이스)에는 영향을 받지 말아야 한다는 의미이다.
  • 클라이언트는 자신이 사용하지 않는 메소드에 의존하지 않아야 한다. 한 클래스는 자신이 사용하지 않는 인터페이스는 구현하지 않는 편이 낫다. 하나의 일반적인 인터페이스보다는 차라리 여러 개의 구체적인 인터페이스가 낫다는 개념을 갖는다.
  • 한 가지 예를 들어보자. 우리는 스마트폰으로 전화, 웹서핑, 사진 촬영 등 다양한 기능을 사용할 수 있다. 그런데 전화를 할 때에는 웹 서핑, 사진 촬영 등 다른 기능은 잘 사용하지 않는다. 따라서 전화 기능과 웹 서핑 기능, 사진 촬영 기능은 각각 독립된 인터페이스로 구현하여, 서로에게 영향을 받지 않도록 설계해야 한다. 이렇게 설계된 소프트웨어는 ISP를 통해 시스템 내부의 의존성을 약화시켜 리팩토링, 수정, 재배포를 쉽게 할 수 있다.

Before Code

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
// 하나의 인터페이스를 모든 클라이언트가 구현하고 있다.
public interface ArticleService{
void list();
void write();
void delete();
}

public class UiList implements ArticleService{
@Override
public void list(){

}
@Override
public void write(){

}
@Override
public void delete(){

}
}

public class UiWist implements ArticleService{
@Override
public void list(){

}
@Override
public void write(){

}
@Override
public void delete(){

}
}

public class UiDist implements ArticleService{
@Override
public void list(){

}
@Override
public void write(){

}
@Override
public void delete(){

}
}

After Code

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// 각각의 클라이언트별로 interface를 구분한다.
public interface ArticleListService{
void list();
}

public interface ArticleWriteService{
void write();
}

public interface ArticleDeleteService{
void delete();
}

public class UiList implements ArticleListService{
@Override
public void list(){

}
}

public class UiWist implements ArticleWriteService{
@Override
public void write(){

}
}

public class UiDist implements ArticleDeleteService{
@Override
public void delete(){

}
}

5.DIP

  • DIP(Dependency Inversion Principle)는 의존성 역전 원칙이라고 한다.
  • 고수준 모듈은 저수준 모듈의 구현에 의존해서는 안된다. 저수준 모듈이 고수준 모듈에서 정의한 추상 타입에 의존해야 한다.
  • 고수준 모듈 : 어떤 의미있는 단일 기능을 제공하는 모듈
    • 바이트 데이터를 읽어와 암호화하고 결과 바이트 데이터를 쓴다.
  • 저수준 모듈 : 고수준 모듈의 기능을 구현하기 위해 필요한 개별 기능 = 좀 더 작은 모듈
    • 파일에서 바이트 데이터를 읽어온다.
    • AES 알고리즘으로 암호화한다.
    • 파일에 바이트 데이터를 쓴다.
  • 중간에 interface와 같은 추상화를 통해서 고수준 모듈과 저수준 모듈이 모두 추상 타입에 의존하게 만든다. 추상을 매개로 메시지를 주고 받음으로써 관계를 최대한 느슨하게 만드는 원칙이다.

설명하는 말들이 어렵다. 모듈도 나오고 이런 추상 타입도 나온다… 쉽게 설명하면 DIP를 만족한다는 것은 의존 관계를 맺을 때, 구체적인 클래스보다는 인터페이스나 추상 클래스와 관계를 맺는다는 것을 의미한다.

이와 같은 말은 변화하기 어려운 것, 변화가 거의 없는 것에 의존하라고 한다. 의미는 변화하기 어려운 부분들을 추상화하여 인터페이스나 추상 클래스로 참조함으로써 DIP를 지킬 수 있다는 뜻이다.

예를 들어 핸드폰의 경우 전화를 하거나 문자를 보내거나 앱을 실행하는 것 자체는 변하기 어렵지만 브랜드의 가격, 모델 명등은 변하기 쉽다. 따라서 변하기 어려운 것은 추상화하여 인터페이스나 추상 클래스로 만들어 참조하면 DIP를 만족하게 될 수 있다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
public class Person{
private String name;
private int age;
private Phone phone;

// getter/setter 생략.
}

// Phone은 추상 클래스.
public abstract class Phone{
private String phoneNumber;

public String getPhoneNumber(){
return phoneNumber;
}

public void setPhoneNumber(String phoneNumber){
this.phoneNumber = phoneNumber;
}

public abstract void call(String phoneNumber);
public abstract void turnOn();
public abstract void turnOff();
}

// 아래와 같이 상속받아 구현한다.
public class GalaxyS7 extends Phone{
@Override
public void call(String phoneNumber){
System.out.println("Call to "+phoneNumber);
}

@Override
public void turnOn(){
System.out.println("Turn on GalaxyS7");
}

@Override
public void turnOff(){
System.out.println("Turn off GalaxyS7");
}
}

만약 갤럭시 핸드폰이 아니라 LG의 G 시리즈나 아이폰 등도 Phone 클래스를 상속받아서 구현하여 Person의 인스턴스 객체의 속성으로 설정함으로서 의존성을 역전시켜 DIP 원칙을 만족할 수 있다.

객체지향 설계 5대 원칙을 공부해봤는데 DIP는 아직 이해가 잘 가지 않는 것 같다. 의존성은 결합도를 낮추는게 목표라고 생각한다. 그래서 느슨한 결합을 만들고 그 과정에서 인터페이스나 추상 클래스를 사용하는 것으로 이해가 된다.

이 부분은 아직 이해가 더 필요한 부분이니 차근 차근 공부해서 보충해나가자.

참고

Comment and share

RESTful API


월드 와이드 웹(World Wide Web a.k.a WWW)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처의 한 형식으로 자원을 정의하고 자원에 대한 주소를 지정하는 방법 전반에 대한 패턴

REST란 REpresentational State Transfer의 약자이다. 여기에 ~ful이라는 형용사형 어미를 붙여 ~한 API라는 표현으로 사용된다. 즉, REST의 기본 원칙을 성실히 지킨 서비스 디자인은 RESTful하다라고 표현할 수 있다.

REST가 디자인 패턴이다. 아키텍처마다 많은 이야기가 존재하는데, 하나의 아키텍처로 볼 수 있다. 좀 더 정확한 표현으로 말하자면, REST는 Resource Oriented Architecture이다. API 설계의 중심에 자원(Resource)이 있고, HTTP Method를 통해 자원을 처리하도록 설계하는 것이다.

REST 구성

REST API는 다음의 구성으로 이루어져 있다.

  • 자원(Resource) - URI
  • 행위(Verb) - HTTP Method
  • 표현(Representations)

REST 6가지 원칙

  1. Uniform
    URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말한다.
  2. Stateless
    무상태성 성격을 갖는다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보자 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만 단순히 처리하면 된다. 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해집니다.
  3. Caching
    REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹 표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용 가능합니다. 따라서 HTTP가 가진 캐싱 기능의 적용이 가능.
    HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능
  4. Client-Server
    REST 서버는 API 제공, Client는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 Client와 Server에게 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 된다.
  5. Hierarchical system
    REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 Proxy, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.
  6. Code on demand

RESTful 하게 API를 디자인 한다는 것은 무엇을 의마하는가

  1. 리소스와 행위를 명시적이고 직관적으로 분리한다.

리소스는 URI로 표현되는데 리소스가 가리키는 것은 명사로 표현되어야 한다.
행위는 HTTP Method로 표현하고, GET(조회),POST(생성),PUT(기존 entity 전체 수정),PATCH(기존),DELETE(삭제)` 을 분명한 목적으로 사용한다.

  1. Message는 Header와 Body를 명확하게 분리해서 사용한다.

Entity에 대한 내용은 body에 담는다.
애플리케이션 서버가 행동할 판단의 근거가 되는 컨트롤 정보인 API 버전 정보, 응답받고자 하는 MIME 타입 등은 header에 담는다.
header와 body는 http header와 http body로 나눌 수도 있고, http body에 들어가는 json 구조로 분리할 수도 있다.

  1. API 버전을 관리한다.

환경을 항상 변하기 때문에 API의 signature가 변경될 수도 있음에 유의하자.
특정 API를 변경할 때는 반드시 하위호환성을 보장해야 한다.

  1. 서버와 클라이언트가 같은 방식을 사용해서 요청하도록 한다.

브라우저는 form-data 형식의 submit으로 보내고 서버에서는 json 형태로 보내는 식의 분리보다는 json으로 보내든, 둘 다 form-data 형식으로 보내든 하나로 통일한다.
다른 말로 표현하자면 URI가 플랫폼 중립적이어야 한다.

장점

  • Open API를 제공하기 쉽다.
  • 멀티플랫폼 지원 및 연동이 용이하다.
  • 원하는 타입으로 데이터를 주고 받을 수 있다.
  • 기존 웹 인프라(HTTP)를 그대로 사용할 수 있다.

단점

  • 사용할 수 있는 메소드가 4가지 밖에 없다.
  • 분산환경에는 부적합하다.
  • HTTP 통신 모델에 대해서만 지원한다.

REST API 디자인 가이드

  1. URI는 정보의 자원을 표현해야 한다.
  2. 자원에 대한 행위는 HTTP Method(GET,POST,PUT,DELETE)로 표현한다.

REST API 중심 규칙

  1. URI는 정보의 자원을 표현해야 한다. (리소스명은 동사보다는 명사를 사용)

GET /members/delete/1

위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다. URI는 자원을 표현하는데 중점을 두어야 하므로 delete와 같은 행위에 대한 표현이 들어가서는 안된다.

  1. 자원에 대한 행위는 HTTP Method로 표현
    위의 잘못 된 URI를 HTTP Method를 통해 수정하면

DELETE /members/1

으로 수정할 수 있다. 회원 정보를 가져올 때는 GET, 회원 추가 시의 행위를 표현하고자 할 때는 POST Method를 사용하여 표현하면 된다.

  • HTTP Method의 역할
  1. POST : POST를 통해 해당 URI를 요청하면 리소스를 생성
  2. GET : GET을 통해 해당 리소스를 조회. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.
  3. PUT : PUT을 통해 해당 리소스를 수정
  4. DELETE : DELETE를 통해 리소스를 삭제

URI 설계 시 주의할 점

  1. 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
  2. URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
    URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고 역으로 리소스가 다르면 URI도 달라져야 한다. REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
  3. 하이픈(-)은 URI 가독성을 높이는 데 사용
    URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI 경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있다.
  4. 언더바는 URI에 사용하지 않는다.
    글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 한다. 이런 문제를 피하기 위해 언더바 대신 하이픈(-)을 사용하는 것이 좋다.(가독성)
  5. URI 경로에는 소문자가 적합
    URI 경로에 대문자 사용은 피하도록 한다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문이다. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정함
  6. 파일 확장자는 URI에 포함시키지 않는다.
    REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다. Accept header를 사용하도록 한다.

리소스 간의 관계를 표현하는 방법

REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같이 표현

/리소스명/리소스 ID/관계가 있는 다른 리소스명

GET : /users/{userid}/devices (일반적으로 소유 'has’의 관계를 포현할 때)

만약에 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있다. 예를 들어 사용자가 ‘좋아하는’ 디바이스 목록을 표현해야 할 경우 다음과 같이 표현 가능

GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적으로 표현이 필요할 때)

자원을 표현하는 Collection과 Document

Collection과 Document에 대해 알면 URI 설계가 한 층 더 쉬워진다. Document는 단순히 문서로 이해해도 되고, 한 객체라고 이해하면 편하다. Collection은 문서들의 집합, 객체들의 집합이라고 생각하면 이해가 편하다. Collection과 Document는 모두 리소스라고 표현할 수 있으며 URI에 표현된다.

http:// restapi.example.com/sports/soccer

sports라는 컬렉션과 soccer이라는 도큐먼트로 표현된다.

http:// restapi.example.com/sports/soccer/players/13

sports, players 컬렉션과 soccer,13을 의미하는 도큐먼트로 URI가 이루어지게 된다. 여기서 중요한 점은 컬렉션은 복수로 사용한다는 점이다. 좀 더 직관적인 REST API를 위해서는 컬렉션과 도큐먼트를 사용할 때 단수, 복수도 지켜준다면 좀 더 이해하기 쉬운 URI를 설계할 수 있다.

HTTP 응답 상태 코드

  • 200 : client의 요청을 정상적으로 수행함

  • 201 : client가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)

  • 400 : client의 요청이 부적절 할 경우 사용하는 응답 코드

  • 401 : client가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
    (로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)

  • 403 : 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 client가 요청했을 때 사용하는 응답 코드
    (403 보다는 400이나 404를 사용할 것을 권고. 403 자체가 리소스가 존재한다는 뜻이기 때문에)

  • 405 : client가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드

  • 301 : client가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드
    (응답 시 Location header에 변경된 URI를 적어줘야 한다.)

  • 500 : 서버에 문제가 있을 경우 사용하는 응답 코드

Comment and share

  • page 1 of 1
Author's picture

VictoryWoo

기록을 통해 사람들과 공유하는 것을 좋아합니다.


Android Developer