Prometheus 데이터 쿼리 방법

Prometheus에서 데이터를 쿼리하는 방식으로는 크게 두 가지가 있다.

• PromQL(Prometheus Query Language)
• HTTP API

이 두가지 방식에 대해 공부해보자.

PromQA

PromQL(Prometheus Query Language)은 Prometheus의 내장 쿼리 언어이다. 시계열데이터(Time Series Data)를 질의, 집계, 필터링, 변환 등의 작업을 수행할 수 있다.

※ 시계열 데이터(Time Series Data) : 시간의 흐름에 따라 수집된 데이터로, 특정 시간 간격을 두고 연속적으로 관측된 값을 의미

sum(), rate(), avg(), max(), min() 등 다양한 함수 및 연산자를 사용해서 복잡한 질의를 구성할 수 있다.

PromQA 예제

단일 메트릭 조회

http_request_total 메트릭의 현재 시계열을 모두 가져옴

http_requests_total

레이블 필터링

최근 5분동안 api-server에서 발생한 HTTP 요청수의 GET 요청 계산

http_requests_total{job="api-server", method="GET"}

범위 선택 + 함수적용

최근 5분 동안의 HTTP 요청 수의 초당 증가율을 계산

rate(http_requests_total{job="api-server"}[5m])

집계 함수

job 별 HTTP 요청수의 증가율을 합산

sum(rate(http_requests_total[5m])) by (job)

수학 연산

메모리 사용률 계산(백분율)

node_memory_MemFree / node_memory_MemTotal * 100

조건 필터링

up 메트릭이 0인 (즉 다운된 대상만 선택)

up == 0

HTTP API

Prometheus가 제공하는 REST API를 사용하여 데이터를 조회하거나 자동화할 때 사용한다.

PromQA 예제

현재 상태조회 쿼리

현재 Target이 살아있는지(UP 상태인지) 확인아있는지(UP 상태인지) 확인

GET /api/v1/query?query=up

응답예시

{
  "status": "success", // 쿼리성공여부
  "data": {
    "resultType": "vector", // 단일 시점의 시계열 결과 (스냅샷)
    "result": [
      {
        "metric": {"job": "node", "instance": "localhost:9100"}, // 해당 시계열의 메타정보{prometheus에서 수집한 job 이름, 해당 타깃의 주소와 포트}
        "value": [1627645327.182, "1"] // 이 시계열 데이터가 수집된 시점의 타임스탬프, up 상태(1:정상, 0:비정상)
      }
    ]
  }
}

HTTP API 예시

성능테스트 테스트 도구에는 k6, JMeter, Locust, Gatling 등이 있다.

이 중, 자사 SSO 를 개발하고나서 성능테스트도 추후에 진행하겠지만 지금은 우선 모니터링 Prometheus + Grafana를 연동하고 있는데 수집 데이터가 많지 않아 시각화를 하는데 무리가 있어 요청데이터를 늘려 모니터링이 정상적으로 잘 되는지 테스트해보기 위해 회사에서 많이 사용하는 JMeter를 학습하고자 정리해본다.

🚀 JMeter 란?

JMeter는 웹 애플리케이션과 서버의 성능을 테스트하기 위한 오픈소스 부하 테스트 도구이다. HTTP, REST API, 데이터베이스, FTP, WebSocket 등 다양한 시스템에 대한 부하/스트레스 테스트를 자동화할 수 있다.

• 다양한 프로토콜 지원 : HTTP, HTTPS, SOAP, REST, JDBC, FTP 등 지원
• GUI 제공 : 테스트 시나리오를 시각적으로 구성이 가능
• 부하테스트 : 수백~수천명의 동시 사용자 시뮬레이션 가능
• 리포트/그래프 제공 : 요청속도, 응답시간, 성공률 등 시각화
• 확장성 : 플러그인, 스크립트(Javascript, BeanShell 등) 지원
• CI/CD 연동 가능 : Jenkins, GitHub Action

🚀 JMeter 다운로드 및 실행

우선 유의사항으로는 성능테스트 시 같은 리소스를 사용하면 정확한 수치를 잴 수 없어 애플리케이션 서버와 테스트(JMeter)서버는 달라야 한다.

다운로드 링크 Apache-JMeter

zpi 파일 다운로드 후 압축해제

apache-jmeter-{version}/bin 폴더 아래에 jmeter.bat 파일을 더블클릭하여 실행

실행 완료 실행을 완료하면 아래와 같은 GUI 화면이 나온다.

🚀 JMeter 테스트 작성

✅ JMeter 테스트 용어 정리

✅ JMeter 테스트 작성

1. 테스트 생성

File - New - Test Plan Name 작성

2. Thread Group(유저설정)

테스트 할 유저를 설정해준다. Test Plan 마우스 우클릭 - Add - Threads (Users) - Thread Group

10명의 유저(Number of Threads (users))가 1초(Ramp-up period (seconds))만에 2번(Loop Count) 반복해서 에러가 발생해도 계속 요청을 보낸다고 설정

옵션 설명

• Name : Thread Group의 이름
• Action to be taken after a Sampler error : Sampler로 테스트 중 에러 시 Action 설정
• Number of Threads (users) : 유저(Thread) 수. 동시에 몇개의 Thread를 발생시킬 것인지에 대한 옵션
• Ramp-up period (seconds) : Thread를 발생시킬 시간
• Loop Count : Thread의 반복 시간. n 으로 값을 설정할 수 있으며 설정된 값에 따라 Number of Threads X Ramp-up period 만큼 요청을 다시 보냄

3. Sampler(유저 Action 설정)

요청을 보낼 Request를 작성해준다. 나는 HTTP 기반 요청을 보낼것이기 때문에 HTTP Request를 추가해주었다. Thread Group 마우스 우클릭 - New - Sampler - HTTP Request 를 선택한다.

x-www-form-urlencoded 형태로 파라미터를 전달을 해야해서 Body data 를 열어서 파라미터를 담아주었다.

4. Header Manager (Header 설정)

위에서 말한 x-www-form-urlencoded 형태로 파라미터를 전달하기 위해 헤더에Content-Type=application/x-www-form-urlencoded 파라미터를 담아주어야 한다.

Thread Group 마우스 우클릭 - Add - Config Element - HTTP Header Manager 를 선택한다.

헤더추가

• Content-Type: application/x-www-form-urlencoded
• KEYCLOAK_LOCALE: ko

5. Listener

결과를 모니터링 하기위해 Listener를 추가해준다.

• view Results Tree
• Summary Report
• View Results in Table 세개를 추가해주었다.

HTTP Request 마우스 우클릭 - Add - Listener - View Result Tree, Summary Report, View Results in Table

6. Assertion

응답 검증을 위해 Assertion을 추가해준다. HTTP Request 우클릭 - Assertions - Response Assertion

응답 텍스트에 "access_token" 이 담겨있으면 성공으로 응답 Assertion을 작성해주었다.

JMeter 테스트 실행

1. 테스트 실행

▶️버튼을 누르면 실행 🧹빗자루 모양 버튼을 누르면 응답 결과를 clear 할 수 있다.

2. 테스트 결과

View Results Tree 페이지를 본 결과 응답 데이터에 access_token을 받아오는 것을 확인할 수 있다.

🚀 Kubernetes의 구성요소

Kubernetes는 컨테이너화 된 Application을 자동으로 배포, 스케일링, 운영 하는 오픈 소스 플랫폼 이며, 아래 이미지와 같이 구조가 계층적으로 구성되어 있다.

☸️ Kubernetes Cluster

Kubernetes의 전체 시스템을 뜻하며, 여러 개의 Node로 구성된 집합체이다.

구성요소

• Control Plane : Kubernetes 클러스터를 전체적으로 제어하는 논리적 개념. 물리적인 실행 호스트는 Node(Master Node)가 담당
• Node : Application(Workload)를 실제 실행하는 서버

☸️ Node

Kubernetes 클러스터 내에서 컨테이너가 실제로 실행되는 물리적/가상 서버

구성요소

• Master Node : Master Node는 Control Plane의 물리적 실행 호스트
• Worker Node : 실제로 Application(Container)을 실행하는 노드. 일반적으로 Node라고 하면 Worker Node를 의미하는 문맥이 많다.(반대로 Master Node는 특별히 구분해서 지칭함)

☸️ Pod

Kubernetes에서 배포 가능한 가장 작은 단위이며, 하나 이상의 컨테이너 그룹을 칭하기도 한다. 하나의 Pod는 하나 이상의 컨테이너를 포함할 수 있으며, 이들은 같은 네트워크를 공유한다. 일반적으로 하나의 Application 단위를 실행한다.

Pod에 Container 가 여러개 있을 순 있지만, 보통은 다른 Application 모음을 한 Pod 내에 배치.

Kubernetes에서 Application의 사용자가 많아지고 트래픽이 증가한다면 Pod를 생성하여 복제하고, 다시 규모를 줄일 때에는 기존의 Pod를 없앤다.

☸️ Container

애플리케이션 실행에 필요한 코드, 라이브러리, 설정 파일 등이 포함된 독립적인 실행 환경 Docker, containerd 등의 Container Runtime을 통해 실행된다.

🚀 ETCD란?

ETCD란 분산된 시스템이나 클러스터의 중요한 데이터를 저장하고 관리하기 위해 사용되는 분산 키-값 저장소이다. 특히, Kubernetes와 같은 컨테이너 오케스트레이션 플랫폼에서 Cluster의 구성데이터, 상태데이터, 메타데이터를 관리하는 데 핵심적인 역할을 수행한다.

🚀 ETCD에 들어있는 정보

• Node에 관한 데이터
• POD에 관한 데이터
• Config 설정 데이터
• Secret 데이터
• Account 데이터
• 권한 데이터
• 바인딩 데이터
• Other,,

🚀 Container Runtime Interface

Container Runtime Interface(CRI)는 어떤 Container Runtime 공급업체던지 Open Container Initiative(OCI)표준을 준수한다면 쿠버네티스의 Container Runtime으로 작업할 수 있게 만들어준다.

Open Container Initiative(OCI) 는 imagespec과 runtimespec으로 구성되어 있다.

• imagespec : 이 이미지가 어떻게 생겼는지 정의 (정적 정보)
• runtimespec : 컨테이너를 실행(run)할 때 어떻게 동작해야 하는지에 대한 기준 정의 (동적 실행정보)

🚀 주요 Kubernetes Container Runtime

Kubernetes에서 사용할 수 있는 Container Runtime들은 여러 종류가 있고, 각자 다른 기술 스택, 성능, 보안성, 유지보수 등을 기준으로 선택받는다.

🐳 Docker (dockershim)

Kubernetes 초기 버전에서 기본으로 사용하던 런타임. CRI표준이 나오기 전에 출시되어 Kubernetes는 dockershim을 이용한 지원을 하고 있었음. dockershim은 도커와 쿠버네티스의 중간에 번역하는 역할을 수행. 하지만 docker만을 위한 dockershim 지원의 어려움으로 인해 Kubernetes v1.24부터 공식적으로 지원 중단되었으며, 현재는 개발환경이나 학습 용도로 사용한 후, 운영환경 전환 시 컨테이너 런타임만 다른것으로 변경하여 동일한 환경에서 Kubernetes를 사용한다.

장점

• 사용하기 쉬움 (GUI 도구, Docker CLI 등)
• 풍부한 에코시스템과 튜토리얼

단점

• Kubernetes에서 공식적으로 제거됨
• 성능, 보안 측면에서 현대적 런타임에 비해 뒤처짐

⛴️ containerd

Docker에서 분리된 경량화 컨테이너 런타임이며, CNCF(Cloud Native Computing Foundation)에서 관리하는 프로젝트다. Kubernetes와의 궁합이 매우 좋아 현재 주류 런타임으로 자리잡았으며 GKE, AKS, EKS 등 대부분의 대형 클라우드 서비스에서 기본 런타임으로 사용한다.

장점

• 경량성과 안정성 우수
• Kubernetes와의 통합이 뛰어남 (CRI plugin 내장)
• Docker 이미지와의 높은 호환성

단점

• 자체 CLI가 불편함
• 일부 고급 기능 부족 (ex. 이미지 빌드, 로컬 개발 편의 기능 등)

🛡 CRI-O

Red Hat 주도로 개발된 Kubernetes 전용 컨테이너 런타임. Docker 없이도 Kubernetes에서 컨테이너를 실행할 수 있도록 설계되었으며, 보안과 경량화에 초점이 맞춰져 있다. OpenShift에서 기본 런타임으로 채택되어 사용된다.

☁️ OpenShift : Red Hat이 만든 Kubernetes 플랫폼 단순한 클러스터 관리 도구를 넘어서 CI/CD, 모니터링, 보안, UI까지 모두 갖춘 엔터프라이즈급 PaaS (Platform as a Service)

장점

• Kubernetes에 최적화되어 있음
• Podman과의 연동 우수
• 보안 기능 강화 (seccomp, AppArmor, SELinux 지원 등)

단점

• 범용성이 낮고 Kubernetes 외 환경에선 사용하기 어려움
• 사용자 및 커뮤니티 규모가 상대적으로 작음

🔐 gVisor

Google에서 개발한 보안 중심의 사용자 공간(User-space) 컨테이너 런타임. 컨테이너를 커널로부터 격리시키는 샌드박스 기술을 사용한다. 주로 민감한 데이터를 다루는 보안 중심 서비스에서 사용한다.

장점

• 매우 강력한 샌드박싱 제공
• 높은 격리 수준 (호스트에 대한 공격면 축소)

단점

• 성능 저하가 있음
• 일부 시스템 호출이 제한되어 호환성 문제가 발생할 수 있음

🧱 Kata Containers

하드웨어 가상화 기술을 기반으로 한 경량 컨테이너 런타임. 컨테이너를 실제 가상 머신처럼 격리해서 실행하며 보안성을 극대화하며 금융, 공공기관, 보안 업계 등 고신뢰 환경에서 사용한다.

장점

• 가상 머신 수준의 높은 격리와 보안성
• 컨테이너 기술과 가상화 기술의 장점을 결합

단점

• VM을 띄우기 때문에 리소스 소모가 큼
• 컨테이너보다 느린 부팅 속도

📝 Container vs VM(가상머신)

⚙️ runC

OCI(Open Container Initiative) 표준을 구현한 저수준 런타임. containerd나 CRI-O 같은 상위 런타임이 내부적으로 사용하는 핵심 실행 엔진이다.

장점

• 매우 경량
• 표준을 정확히 준수

단점

• 저수준 런타임이기 때문에 단독 사용 시 불편하며, 보통 다른 런타임과 함께 사용됨

Kubernetes는 컨테이너 관리 자동화(Orchestration) 시스템이다. 쉽게말해 컨테이너들을 똑똑하게 띄워주고, 필요하면 옮기고, 고장나면 다시 띄우고, Load Balancing도 수행해준다. 이 모든것을 자동으로 해주는 시스템이다.

🚀 Kubernetes 유형

☸️ 관리형 쿠버네티스(Managed Kubernetes)

대표 예시

• AWS EKS
• Azure AKS
• Google GKE

특징

• 클러스터의 Control Plane 및 인프라 자원을 관리해주며, 사용자는 Application만 배포/운영
• 유지보수, 업그레이드, 고가용성 등을 클라우드에서 자동으로 제공
• 비용을 줄이고 빠르게 시작하고 싶을 때 사용

장점

• 빠른 구축, 높은 안정성
• 인프라 운영 부담 최소화

단점

• 세세한 커스터마이징 제한
• 클라우드 종속성
• 사용된 만큼 비용 발생

☸️ 설치형 쿠버네티스(Packaged Kubernetes Platform)

대표 예시

• Red Hat OpenShift
• Rancher
• VMware Tanzu

특징

• 쿠버네티스에 다양한 운영/보안/관리 기능이 포함된 일체형 플랫폼
• GUI, 멀티 클러스터 관리, CI/CD, 인증 연동 등 기능을 패키지 형태로 제공
• 기업용 기능과 지원이 필요한 경우 사용

장점

• 엔터프라이즈 환경에 적합한 기능 제공
• 운영 자동화 및 보안 기능 강화

단점

• 상대적으로 복잡한 구조
• 초기비용이 크고 유지비도 높은 편

☸️ 구성형 쿠버네티스(DIY Kubernetes / Provisioning Tool-based)

대표 예시

• kubeadm
• kops
• Kubespray

특징

• 사용자가 직접 구성 요소를 선택하고 설정하여 쿠버네티스 클러스터를 구축한다.
• 자유도와 유연성이 높음
• 베어메탈 서버, 온프레미스 환경, 커스텀 클라우드 환경 등에 적합 베어메탈 서버 : 물리 서버를 가상화 없이 통째로 하나의 사용자(또는 조직)가 단독으로 사용하는 서버
• 오픈소스 기반이라 소프트웨어 자체는 무료지만, 설정/모니터링/업그레이드까지 모두 직접해야하므로 DevOps나 인프라 전문가가 필요하다.

장점

• 학습 및 교육용으로 매우 유용
• 세밀한 설정 가능 (예: 네트워크 플러그인, 저장소 구성 등)

단점

• 설치 및 유지보수에 대한 운영 부담이 큼
• 관리 자동화 기능 부족

🚀 Kubernetes 아키텍처

이미지 출처 : Linux Foundation - 쿠버네티스 아키텍처 소개

🚀 아키텍처 구성요소

🧠 Control Plane

Kubernetes의 두뇌역할을 담당하고있으며 클러스터의 신경 중추라고도 표현한다. 여기에는 클러스터를 제어하는 쿠버네티스 구성 요소와 상태 및 구성에 관한 데이터가 함께 있다. Manage, Plan, Schedule, Monitor Nodes 등을 수행한다.

kube-api

클러스터 내에서 모든 작업은 여기를 통해 들어오고 나간다. Control Plane 에서 Worker Node에게 지시를 할 때도 kube-api를 지난다.

kube-scheduler

지금 사용 가능한 컨테이너와 기타 조건들을 기준으로 스케줄을 조정해주는 모듈 CPU, Memory상황등을 보고 이 Pod는 Node2에 올리자 등 이런식으로 판단해준다.

더 자세히 말하자면, Kubernetes는 두 단계를 거쳐 Pod에 가장 적합한 Node를 찾아준다.

• Fileter Nodes : CPU, Memory 요구사항이 맞지 않는 Node를 걸러낸다.
• Rank Nodes : 우선순위 함수를 이용하여 Node마다 점수를 매겨, 가장 효율적이고 리소스 누수가 없는 적합한 Node를 찾는다.

kube-controller-manager

kubernetes에서 controller는 시스템 내 다양한 구성 요소의 상태를 지속적으로 모니터링하고 시스템 전체를 원하는 상태로 만드는 것을 의미한다. controller는 scheduler를 참고하여 정확한 수의 Pod가 실행되도록 컨트롤 한다. Pod가 3개 있어야 함 -> 하나 죽으면 새로 만들어줌

Kuber-Controller-Manager 안에는 Node Controller, Job Controller, Deployment Controller, Namespace Controller, Endpoint Controller, PV-Protection Controller, Replication Controller, Replicaset Controller, Stateful-Set Controller, CronJob Controller 등 다양한 Controller가 포함되어 있다.

ETCD Cluster

어떤 배에 어떤 컨테이너가 들어있고, 몇시에 적재되었는지 등 쿠버네티스의 모든 설정, 상태, 위치 정보 저장 정보를 담고있는 고가용 키-값 데이터베이스. 모든 정보를 담고 있기 때문에 클러스터의 "진짜 뇌" 라고도 부른다.

⛴️ Compute machines(Worker Node)

Compute Machine == Worker Node == 일꾼 노드 쿠버네티스에서 실제로 컨테이너(Pod)가 돌아가는 서버를 말한다. 일반적으로 하나의 클러스터에는 여러개의 Worker Node가 있고, 각각이 Container를 실행한다.

kubelet

클러스터의 각 노드에서 실행되는 에이전트. 컨테이너를 띄우고 Control Plane(kube-apiserver)랑 소통하여 컨테이너를 실행/모니터링 등 관리한다. kube-api(선장)의 지시를 듣고 kubelet(선원)이 필요한 대로 노드에서 컨테이너를 배포하거나 파괴함 kube-api(선장)은 주기적으로 kubelet(선원)에게 상태보고서를 받음(컨테이너 상태 모니터) kubeadm으로 설치 시 kubelet을 수동으로 따로 설치해주어야 한다.

kube-proxy

네트워크 관리자 역할을 수행한다. 외부 트래픽이 올 때 적절한 Pod로 라우팅 하는 역할을 수행한다. 클러스터 내 작업자 노드에 필요한 네트워크 규칙을 설정하고 시행되도록 한다.

Container runtime

컨테이너를 실제로 실행하는 컨테이너 Runtime을 의미한다. docker, containerD, rkt 등 종류가 있다.

Pod

컨테이너를 담는 상자이다. 하나 이상의 컨테이너를 담는 최소 실행 단위를 뜻하는데, 보통 Pod라고 하면 하나의 컨테이너 + 부가적인 설정 정도로 생각하면 된다고 한다.

Containers

nginx, mysql, node.js 등 애플리케이션이 실제로 실행되는 단위이다.

💾 Persistant storage

데이터를 유지하는 저장소이다. Pod가 죽거나 이동해도 데이터가 남아 있어야 할 때 사용한다. 종류에는 AWS EBS, NFS, GCP Persistent Disk 등이 있다.

🏠 Container registry

이미지를 저장하고 가져오는 창고이다. DockerHub, Google Container Registry(GCR), private registry 등의 종류가 있다. kubectl apply 명령어를 요청하면 여기서 이미지를 받아와서 컨테이너로 실행한다.

개요

휴대폰에서 앱을 실행하면 보통 로고나 앱 이름이 박힌 로딩화면을 거쳐 메인화면으로 앱이 켜질 것이다. 이 로딩화면을 Splash 화면이라고 명칭한다.

오늘은 이 Splash 화면을 구현해볼 것이다.

참고 문서 - Flutter Splash

1. 패키지 dependency 설정

먼저, 프로젝트의 pubspec.yaml 파일에 dependency를 추가한다.

dependencies:
  flutter_native_splash: ^2.4.4

그리고 pubspec.yaml 경로로 이동하여 flutter pub get 명령어를 실행시켜 dependency를 적용시켜 준다.

$ flutter pub get

2. splash 설정

pubspec.yaml 파일에 바로 적용을 할 수 있는 방법도 있고, flutter_native_splash.yaml 파일을 루트 디렉토리에 생성하여 관리를 하는 방법도 있다.

나는 flutter_native_splash.yaml 파일을 생성하여 따로 적용해보도록 하겠다.

우선 루트 디렉토리에 flutter_native_splash.yaml 이름을 가진 파일을 하나 생성해준다.

참고 문서 - Flutter Splash 에 나오는 설정 yaml 파일을 복사해서 붙여넣는다.

복사해서 붙여넣으면 아래와같이 많은 옵션들이 적힌 파일을 가져올 수 있다.

나는 로고 이미지와 배경색상(background-color)를 변경할 것이다.

우선 사용할 로고 이미지를 assets 경로에 넣어준다. flutter_native_splash.yaml 자체에서 로고의 크기를 조절하는 기능은 아직 지원하지 않는다고 해서 크기별로 로고 이미지를 추출하여 저장해주었다.

아래와 같이 설정 정보를 저장해준다.

flutter_native_splash:
  color: "#31363F"
  image: assets/logo/YEONTA_logo_80.png
  fullscreen: true

3. splash 실행

이제 설정한 splash를 실행시켜 볼것이다.

$ dart run flutter_native_splash:create

그리고 나서, 프로젝트를 실행해 보면 splash를 확인할 수 있다.

지금은 데모앱으로 실행중이라 조금 빠르게 지나가지만, 분명히 splash가 정상적으로 적용된 것을 확인할 수 있다.

splash는 flutter가 실행되는동안 유지된다고 한다.

이상 splash를 알아보았다!

Class

Class란?

Dart는 객체지향 언어이다. 모든 객체는 Class의 Instance이다.

Class는 Member를 가진다. Member 안에는 Member Method(멤버 함수)과 Member Variable(멤버 변수, 인스턴스 변수)를 가진다.

*🔥 참고 : *

• 클래스 밖에서 하나의 기능을 하는 것은 Function 이라고 하고, 클래스 내부에 있는 함수는 Method 라고 한다.
• 멤버 변수는 객체가 생성되면 인스턴스 변수라고한다.

Class의 기본형태

class 클래스명 {
    멤버변수
    멤버함수
}

예시

class Player {
    // 멤버변수
      final String name; // final은 수정할 수 없음
      int xp, age;
      String team;

    // 멤버함수
    void sayHello() {
        print("hi my name is $name $age $team $xp"); 
      }
}

생성자

Class 객체를 생성하여 인스턴스를 생성할 때 사용하는 것이다. 선언된 멤버변수에 어떻게 값을 대입할지에 대해 선언하는 함수이다. 생성자 Method의 이름은 Class의 이름과 같아야한다.

basic Constructor

기본적인 Dart의 생성자를 살펴보자.

class Player {
    // 멤버변수
      late String name; // final은 수정할 수 없음
      late xp,;

    // 생성자(Constructor)
      Player(String name, int xp) {
        this.name = name;
        this.xp = xp;
      };
}

void main () {
    print player = Player("hee", 15000);
}

• late 선언을 통해 객체가 생성되면서 값을 할당 할 수 있도록 한다.
• 객체를 생성할 때 C++ 이나 Java의 경우 new를 통해 생성하지만, dart는 그냥 해당 클래스를 호출하면서 생성자에 값을 담아주면 된다.

Positioning Constructor

Positioning Constructor는 생성자를 호출할 때 선언해 놓은 순서대로 변수를 할당하는 생성자이다.

class Player {
      final String name; // final은 수정할 수 없음
      int xp, age;
      String team;

      // positioning parameter
     Player.createRedPlayer(String name, int age) : 
        this.age = age,
        this.name = name,
        this.team = 'grey',
        this.xp = 0;
}

void main () {
    print player = Player("hee", 26);
}

Named Constructor Parameters

생성자를 key값인 변수 이름을 가지고 해당 멤버변수에 값을 대입하는 방법이다. 멤버 변수가 많아질 경우 생성자에 값을 하나 하나 담아서 호출해야 하므로 dart 언어는 named constructor를 지원한다.

class Player {
      final String name; // final은 수정할 수 없음
      int xp, age;
      String team;

      // named parameter
      Player.createBluePlayer({
        required String name, 
        required int age,
      }) :  this.age = age,
        this.name = name,
        this.xp = 0,
        this.team = 'grey';
}

void main () {
    print player = Player("hee", 26);
}

required 를 사용하여 값이 비어있다면 호출하지 못하도록 막고, 필수값이 아니어도 되는 변수의 경우 :(콜론)을 사용하여 값을 할당받지 못했을 때 default 값을 설정할 수 있다.

API(Json) 읽어와서 Class에 할당하기

Map타입의 생성자를 만들어서 Json 파일에 담긴 데이터를 멤버변수에 담으면 된다.

class Player {
  final String name; // final은 수정할 수 없음
  int xp, age;
  String team;

  Player.formJson(Map<String, dynamic> playerJson)
    : name = playerJson['name'],
      age = playerJson['age'],
      xp = playerJson['xp'],
      team = playerJson['team'];

  void sayHello() {
    print("hi my name is $name $age $team $xp"); // $name = ${this.name}
  }
}

main() {

  /* API */
  var apiData = [
    {
      'name' : 'heera',
      'team' : 'red',
      'xp' : 12000,
      'age' : 15,
    },
    {
      'name' : 'amily',
      'team' : 'red',
      'xp' : 15000,
      'age' : 20,
    },
    {
      'name' : 'juno',
      'team' : 'red',
      'xp' : 16000,
      'age' : 18,
    },
  ];

  apiData.forEach((playerJson){
    var player = Player.formJson(playerJson);
    player.sayHello();
  });
}

Cascade Notation(객체 생성 문법)

객체를 생성할 때 basic 하게는 아래와 같은 방식으로 호출한다.

var duck = Member(name: 'duck', age: 26);

하지만 Cascade Notation[..]을 사용하면 하나의 오브젝트에 함수호출, 필드접근을 순차적으로 할 수 있다. 자바의 build()와 유사하다.

var duck = Member
  ..name = 'duck_ach'
  ..age = 26
  ..phoneNum = '010-0000-0000'
  ..getUserInfo();

Abstract Class(추상 클래스)

Abstract Class(추상클래스)는 이를 상속받는 모든 클래스가 가지고 있어야 할 메소드를 정의한 클래스이다. (구현 X)

abstract class Human {
  void walk();
}

class Duck extends Human {
  @override
  void walk() {
    print('Duck is walk');
  }
}

Inheritance(상속)

상속은 super 라는 선언을 통해 부모클래스의 생성자를 호출할 수 있다.

Human 클래스를 부모클래스로 선언하고, Player 클래스에서 extends를 사용하여 상속받는 코드이다.

필요한 개별부분들은 자식클래스에서 선언하고, 공통적인 요소나 메소드는 부모클래스에서 상속받아 코드를 좀 더 통일성 있게 짤 수 있다.

class Human {
  final String name;
  Human(this.name);
  void sayHello() {
    print('Hi. my name is $name');
  }
}

enum Team {blue, red}

class Player extends Human {
  final Team team;
  Player({
    required this.team,
    required String name
  }) : super(name);

  // 부모클래스가 정의한 메소드말고 커스텀하고싶을 때
  @override
  void sayHello() {
    //print('Hi. my name is $name 1111');
    super.sayHello();
    print('and I play for ${team}');
  }

}
void main() {
  var player = Player(
    team: Team.red,
    name : 'heera',
    );
    player.sayHello();
}

Mixin(생성자가 없는 클래스)

Mixin는 생성자가 없는 클래스를 의미한다. 클래스에 필터나 메소드를 뺏어올 때 사용한다.

Inheritance(상속) 이랑은 개념이 다른게, 상속은 super 를 통해 접근해서 부모가 가진것을 자식이 물려받아 사용한다는 개념이지만, mixin은 그저 with 으로 class를 생성할 때 선언을 함께 해주며, 그 안에 있는 필드값이나 메소드를 공유하며 사용한다.

생성자가 없는 것이 가장 큰 특징이다.

mixin을 생성할 땐 mixin 을 사용한다. (원래는 class 의 한 형태여서 class를 사용하여 만들었지만 최근에 업데이트가 된 모양이다.)

// mixin타입으로 선언해줌 필드 가지고 있고, 생성자 안가지고 있음
mixin Strong {
  final double strengthLevel = 1500.99;
}

// 클래스고, 메소드 가지고 있고, 생성자 안가지고 있음
mixin PlayBaseball {
  void runQuick() {
    print("homer!!");
  }
}

mixin Tall {
  final double height = 162.49;
}
enum Team {blue, red}

class Player with Strong, PlayBaseball, Tall {
  final Team team;
  Player({
    required this.team,
    required String name
  });
}
void main() {
  var player = Player(
    team: Team.red,
    name : 'heera',
    );

  player.runQuick();

}

typedef

Dart에서는 함수의 타입을 typedef를 이용하여 정의할 수 있다. 특히 Map, List, Set 등의 자료구조로 함수의 값을 반환할 때도 미리 함수의 타입을 정의하여 변수로 정의해두고 사용할 수 있다.

typedef를 사용했을 때 장점으로는

• 가독성이 높아진다.
• 복잡한 함수가 많을 경우 코드가 간결해진다.

문법

typedef 변수 = 함수타입;

예시

// list를 ListOfInts 라는 변수에 담기
typedef ListOfInts = List<int>;

// ListOfInts 반환
ListOfInts reverseListOfNumbers(ListOfInts list) {
  var reversed = list.reversed;
  return reversed.toList();
}

복잡한 함수를 사용해야하는 경우는 위와 같이 typedef를 잘 활용하면 좋지만, dart는 강력한 제네릭 기능을 갖추고있어 타입을 명시적으로 선언하지 않아도 되기 때문에 상황에 따라 고려하여 선언하여 사용하는 것이 좋다.

Dart 언어의 함수는 만드는 방법이 간단하다.

반환타입 메소드이름(파라미터) {
    동작
}

위와 같은 형식으로 만들어주면 된다.

bool haveMoney(int money) {
    return money != null;
}

// void == 반환 값 X
void sayHello(String name) {
      print("Hello $name nice to meet you!");
}

또는 짧고 간단한 함수의 경우 Syntax Return 을 사용하여 간단하게 => 를 활용하여 한줄로도 표현할 수 있다.

// Syntax return 사용
String sayHelloSyntaxReturn(String name) => "Hello $name nice to meet you!";

num plus(num a, num b) => a + b;

파라미터(Parameter)

파라미터는 2가지 방법으로 전달할 수 있는데 하나는 position 기반으로 파라미터를 읽는 position parameter, 하나는 직접 name을 파라미터와 함께 지정하여 사용하는 named parameter 이다. named parameter의 경우 json 통신이랑 매우 비슷하다고 느꼈다.

position Parameter

position Parameter의 경우 Java처럼 파라미터에 어떤값이 들어올지, 지정하고 호출할 때도 파라미터를 그냥 그 자리에 맞춰 호출하면 된다.

void sayHello(String name, String greeting) {
  print("Hello $name $greeting");
}

int pow(int n) => n * n;

main() {
    sayHello('duck', 'nice to meet you!');
    pow(3);
}

또는 특정 파라미터만 Optional 하게 지정할 수도 있다. nullable variables 를 이용한 방법이다.

String sayHello(String name, int age, [String? country = 'korea']) => 'Hello $name, you are $age years old from $country';
main() {
  print(sayHello('duck', 25));
  // Hello duck, you are 25 years old from korea

}

또 다른 비슷한 방법으로 연산자 QQ Operator ??= 를 활용하는 방법이 있다.

만약 null 값일 수도 있는 파라미터를 넣는다고 가정했을 때 아래와 같이 if문을 넣어 null인지 체크한 후 함수를 호출해야 오류가 안난다.(함수 호출을 하는 곳에서 오류)

// 변경전
String capitalizeName(String? name) {
  if(name != null) {
    return name.toUpperCase();
  }
  return 'ANON';
}

// 변경후
String capitalizeName2(String? name) => name != null ? name.toUpperCase() : 'ANON';

main() {
    String? name;
      name ??= 'heera';
      capitalizeName2(name); // HEERA
}

named parameter

named parameter는 key와 value를 호출할 때 명시해준다.

하지만 이 named parameter 방법의 경우 만약 파라미터가 3개라면 3개의 파라미터를 다 받아야하는데 누락이 될 수 있는 문제가 있다. 그래서 default 값을 명시해준다. 호출을 할 때 해당 파라미터는 전달하지 않고 호출했다면 default 값이 할당된다.

String namedParameter1({String name = 'anon', int age = 0, String country = 'hello world'}) {
  return "Hello $name, you are $age, and you come from $country";
}
main() {
    print(namedParameter1(
        name: 'duck', 
        age: 25, 
      ));
    // Hello duck, you are 25, and you come from hello world

    print(namedParameter1());
    // Hello anon, you are 0, and you come from hello world

}

만약 모든 파라미터가 꼭 들어와야한다면 required 선언을 해주면 된다.

String namedParameter2({
    required String name, 
    required int age,
    required String country}) {
  return "Hello $name, you are $age, and you come from $country";
}
main() {
    print(namedParameter2(
    name: 'duck', 
    age: 25, 
    country: 'japan', 
  ));
  // Hello duck, you are 25, and you come from japan![](https://velog.velcdn.com/images/duck-ach/post/a358600d-595e-4226-b945-caaa29080a64/image.png)

}

자바스크립트의 $ 기호와 비슷한 역할을 한다.

예시

아래 사용 예시처럼 변수를 담아 결과를 도출할 수 있다.

var name = 'Duck';
print("Hello, $name");
print("$name님 환영합니다.");

여러개의 변수를 담을 수 있다.

var firstName = 'Duck';
var lastName = 'Ach';
print("Hello, $firstName $lastName");
print("$firstName $lastName 님 환영합니다.");

또는 꼭 문자열이 아니더라도 변수에 다른 값을 담아 연산하여 결과를 도출할 수도 있다.

var adult = 20;
print('${adult + 5}살 입니다.');

🦋 자료형(Data Type)

Dart 언어는 다음과 같은 자료형을 지원한다.

1. Numbers(int, double)

숫자(Number)를 나타내는 자료형에는 int와 double을 지원하며, int와 double의 부모 클래스인 num 도 지원한다.

int

int 형은 정수를 나타낼 때 쓰이며, 사용하는 플랫폼에 따라서 정수 값은 64비트 이하로 표현된다.

• 네이티브 플랫폼에서는 -263 ~ 263 - 1 까지 표현된다.
• 웹에서는 Javascript numbers (가수부가 없는 64-bits 부동소수점 표현) -253 to 253 - 1 사이의 수로 표현된다.

예시

var num = 2345834532;
int one = 1;
int two = 2;
int age = 25;

double

double 형은 소수를 나타낼 때 쓰이며 IEEE 754 standard를 따라 64-bit (배정도) 부동 소수점 표현을 사용한다.

숫자가 소수점을 가지고 있다면 double 형이라고 생각하면 된다. 예시

var percent = 35.22222222;
double price = 25.99;
double average = 97.8;

num

num 형은 int형과 double형의 부모 클래스로써 정수가 될 수도, 소수가 될 수도 있는 자료형태이다.

예시

num x = 1; // x는 int, double 둘 다 가능합니다.
x += 2.5;

2. Strings(String)

String

String 형은 문자열을 만들 때 사용되며 작은 따옴표, 큰 따옴표 모두 사용이 가능하다.

예시

var hello = "안녕하세요";
var name = 'duck';
String fruit = "mango";

3. Booleans(bool)

bool

Dart는 Boolean 타입을 bool 로 명명했다. bool은 true(참) 또는 false(거짓)을 나타낼 때 사용된다.

예시

// 빈 문자열인지 확인합니다.
var fullName = '';
assert(fullName.isEmpty);

// 0인지 확인합니다.
var hitPoints = 0;
assert(hitPoints <= 0);

// null인지 확인합니다.
var unicorn = null;
assert(unicorn == null);

// NaN인지 확인합니다.
var iMeantToDoThis = 0 / 0;
assert(iMeantToDoThis.isNaN);

🦋 자료구조(Data Structure)

1. List

Java의 List와 별 다른점이 없다. 중복값을 추가할 수 있으며, 그냥 add(값) 을 하면 맨 뒤에 데이터가 추가되고, add(index)를 하면 해당 index에 값을 추가할 수도 있다. [] 대괄호 로 표현한다. var 로 선언해도 [] 를 통해 컴파일러가 List로 인식한다.

예시

  var numbers = [1, 2, 3, 4]; // var 키워드 사용해도되고
  List<int> numbers2 = [
    1,
    2,
    3,
    4,
    if (true) 5,
  ]; // Type을 명시해줘도됨
  print(numbers); // [1, 2, 3, 4]
  print(numbers2); // [1, 2, 3, 4, 5]

2. Map

Map도 Java의 Map이랑 다른점이 없다. key:value 의 형태이며, key값은 고유하다. var로 선언해도 key:value 형태를 통해 컴파일러가 Map으로 인식한다.

예시

  var player = {
    'name': 'nico',
    'xp' : 19.99,
    'superpower' : false,
  };
  Map<List<int>, bool> compEx = {
    [1,2,3,5]: true,
  };

  print(player); // {name: nico, xp: 19.99, superpower: false}
  print(compEx); // {[1, 2, 3, 5]: true}

3. Set

Set도 Java의 Set이랑 다른점이 없다. Set을 통해 데이터를 취합하면 중복값은 없어져서 중복값이 없어진 데이터 Set이 된다. {} 중괄호 로 표현한다. var로 선언해도 {}를 통해 컴파일러가 Set으로 인식한다.

예시

var numbered = {1,2,3,4};
  numbered.add(1);
  numbered.add(4);
  numbered.add(3);
  numbered.add(1);
  numbered.add(1);
  print(numbered); // {1,2,3,4}

기존에는 null값을 참조하면 런타임 에러가 발생할 수 있었지만, Null Safety를 통해 컴파일 전에 이러한 오류를 방지하기 위해 만들어졌다.

이는 사용자가 앱을 사용하는 동안 발생하는 런타임 에러를 최소화하여 더 안정적인 코드를 작성할 수 있도록 도와준다.

Null Safety 예시

Dart에서 Null Safety가 적용된 예시를 확인해보자.

String타입인 변수 string의 값이 0이라면 true, 아니라면 false를 반환하는 함수이다.

bool isEmpty(String string) => string.length == 0;

main() {
    isEmpty(null);
}

함수를 호출할 때 null을 파라미터로 보냈기 때문에 벌써 null에 빨간줄이 뜨고, 실행을 하더라도 에러가 뜰 것이다.

Nullable

하지만 개발을 하다보면 API 요청을 해서 불러온 데이터가 Null 일 수 도있고, Null을 사용해야 하는 경우가 분명 존재한다. 그럴 땐 Nullable이 되도록 바꿔보자.

변수 뒤에 ? 를 붙여 Nullable로 변경할 수 있다. Nullable이 된다면 변수가 Null값이면 참조하지 않고, Null이 아니라면 함수가 실행될 것이다.

bool isEmpty(String? string) => string?.length == 0;

main() {
  isEmpty(null);
}

변수 선언을 할 때 타입에도 ?를 붙여주어야 하고, 해당 변수 뒤에도 ?를 붙여 함수를 호출한다.

실행결과 - null 값을 파라미터로 보냈기 때문에 참조하지 않아 결과가 없다.

🦋 변수

Dart에서 변수를 선언할 때 3가지 방법으로 할 수 있다.

var

주로 함수나 메소드 내에서 지역변수를 사용할 때 사용한다.

만약 var를 사용하여 문자열을 선언했다면,

var food = 'pasta';

아래에서 다른 데이터 타입의 변수를 해당 변수에 넣지 못한다.

var food = 'pasta';
food = 11; // error
food = true; // error

Type

주로 Class 내 지역변수나 properties 를 선언할 때 사용한다.

문법이 Java랑 되게 비슷하다는 생각을 했다. 해당 문법도 String이라고 지정해주었기 때문에 다른 데이터 타입은 변수에 할당되지 않고 에러가난다.

String food = 'pasta';
food = 11; // error
food = true; // error

var 를 사용하던 구체적인 타입을 선언해서 사용하던 컴파일러가 데이터 타입을 인식하는 것은 똑같다.

Dynamic

주로 데이터 타입을 알 수 없거나, flutter에서 json이랑 사용할 때 동적으로 데이터 타입 변환이 필요한 경우, 또는 데이터 타입의 확인이 필요할 경우 사용한다.

보통은 Dynamic 변수를 선언을 많이 사용하지 않게 권장하고 있지만, 특정의 경우에는 사용할 수 있도록 Dart에서 지원하고 있다고 한다.

변수를 var로 선언한 후, 초기화 하지않고 그 아래에서 변수 값을 할당한다면 변수의 타입이 Dynamic으로 지정되기 때문에, 아래처럼 여러 데이터타입의 변수 선언이 다 가능하다.

var food;
food = 'fasta';
food = 11;
food = true;

또는 dynamic으로 선언할 수 있다.

dynamic food;
food = 'fasta';
food = 11;
food = true;

Dynamic 변수의 또 다른 특징은 Dynamic 변수를 선언한 후, String 값을 할당했더라도 타입을 특정하지 못하기 때문에 관련 함수가 조회되지 않는다.

var food;
food = 'fasta';

하지만 Dynamic 변수에 String 이라면, int 라면 등등 조건을 달아준 후 그 해당 단락 내에서는 해당 데이터 타입의 함수를 사용 할 수 있게 된다.

🦋 상수

값이 변하는 변수와 다르게 값이 변하지 않으면 안되는 상수 선언은 간단하다.

const

const는 compile 단계부터 값을 알고 있는 것이다.

• API를 통해 받아오는 값 X
• 사용자가 입력하는 값 X

const userId = 'duck-ach';

final

동적인 초기화를 한 후 값이 변하지 않는 상수를 유지하고 싶다면 final 을 이용하여 선언해주면 된다.

final userName = 'duck';

만약 밑에서 값을 바꾸려고 하면 에러가 난다.

final userName = 'duck';
userName = 'ach'; // error

🦋 수식어

late

late 수식어는 주로 변수나 상수 앞에 붙여준다. 먼저 변수/상수 앞에 선언해 놓고, api를 통해 나중에 값을 할당하거나 다른 작업을 한 후 값을 할당 할 경우 사용한다.

late final String name;

사용을 할때에는 값을 꼭 할당하고 사용을 할 수 있다.

late final String name;
print(name); // error

late final String name;
name = 'duck';
print(name); // duck

결론 정리

• dart는 기본적으로 var 선언을 권장하며, class나 property 를 작성할 때는 Type 선언을 권장한다.

• 변수를 단 한번 할당한 후 값을 바꾸고 싶지 않다면 final 선언을 하면된다.

• dynamic 선언의 경우 가장 조심스럽게 사용하도록 권장된다. 타입에 대해 조건을 걸어주어야 그 타입에 대한 함수를 사용 할 수 있다.

• const 는 이미 값을 알고있고, 타입을 알고 있는 경우 사용한다. 컴파일단계부터 이미 값을 다 알고 실행되기 때문에 API를 통해 값을 받아오거나 사용자가 입력한 값을 할당할 수는 없다.

• late 는 변수 선언 후 나중에 값을 할당할 때 사용된다. 정의 되지 않은 late 변수는 사용할 수 없다.

flutter는 dart 라는 언어 기반으로 컴파일 되는데 dart가 flutter 맞춤형 언어라고 할 만큼 fit이 좋고 빠르다고 한다. react-native도 고려했지만 여러 앱을 혼자 만드는 데 있어서 학습하는 시간과 개발 시간이 많이 들것이라고 예상했다.

그럼 본격적으로 dart 언어부터 배워보기 위해 프로젝트 세팅을 해보자!

1. 별다른 설치 없이 하는 방법

dart는 정말 친절하게도 웹 브라우저에서 개발하고 실행하고 화면을 확인할 수 있도록 지원한다. 맨날 새로운 프로젝트를 할 때마다 새로운 언어를 쓰거나 프레임워크가 바뀌면 프로젝트 세팅 하고 익히느라 한세월씩 가는데 사실 이 사이트 보고 좀 놀랐다.

dartpad.dev 라는 사이트로 이동하면 된다.

2. VSCode 기반으로 프로젝트 세팅하는 방법

사실 웹 브라우저 에서 별다른 설치 없이 지원을 해주니깐 1번의 방법으로 사용해보고 싶었는데 내 2015년식 💩 Mac은 자꾸 버벅거리고 렉걸린다. 가끔 버튼도 안눌려서 VSCode로 설치해보기로 했다.

1. 우선 VSCode를 다운로드 받는다.

2. Flutter 확장프로그램 설치

Flutter를 설치하면 dart 확장프로그램도 자동으로 다운로드 받아진다.

확장프로그램 다운받고 나서, VSCode 재부팅 한번 해준다.

3. 프로젝트 생성

⌘(Command) + ⇧(Shift) + p 단축키를 눌러 Dart: New Project 를 선택하고 만들어주면 된다.

Console Application을 선택해준다.

프로젝트 경로를 선택해주고, 이름을 입력한다.

프로젝트 생성 완료

4. 실행(run)

F5를 누르면 debug 모드로 실행이 가능하다. !

회사에서 다음주부터 Apache Struts2 프레임워크에서 발견된 원격코드 실행 관련 보안취약점을 해결해야해서 프로젝트 투입 전 간단히 Apache Struts 프레임워크에서 사용하는 문법과 종속 라이브러리 정보 등을 톮아보자.

※ 톮아보다 : 샅샅히 톮아 나가면서 살피다. (순우리말)

Apache Struts

Apache Struts는 Apache 사에서 만들어진 Java EE 애플리케이션을 개발하기 위한 MVC 아키텍처 기반 오픈 소스 프레임워크다.

Apache Struts의 특징으로는 POJO(Plain Old Java Object) 기반의 Actions를 사용하여 HTML Form 이나 다른 리소스들에 대한 요청들을 처리한다.

보안취약점

• CVE-2019-0230 설명 : 사용자 입력 데이터 검증이 미흡하여 발생하는 원격코드 실행 취약점 영향 받는 버전 : Struts 2.0.0 ~ 2.5.20

• CVE-2020-17530 설명 : CVE-2019-0230의 보안패치를 우회한 원격코드 실행 취약점 영향 받는 버전 : Struts 2.0.0 ~ 2.5.25

해결책으로는 권고사항인 Apache Struts 프레임워크를 업그레이드 하는 방안으로 진행하기로 했다.

문법 및 용어

Actions

Struts 2 Web Application에서 하이퍼링크를 클릭하거나 HTML Form을 Submit하면 Struts 내의 자바 클래스로 전송된다. 이런 요청을 받는 클래스를 Actions라고 한다. Action이 실행된 후, Result는 응답을 렌더링할 리소스(Java, html, jsp, file 등)를 선택할 수 있고, 실행 결과에 따라 SUCCESS, ERROR, INPUT 과 같은 result-name 을 반환할 수 있다.

struts.xml 파일

struts.xml 이라는 xml 파일을 통해 모든 연결관계를 확인할 수 있다.

struts.xml

<action name="index" class="com.struts.MainAction">
    <result name="index">/index.jsp</result>
</action>
<action name="login" class="com.struts.LoginAction">
    <result name="login">/login/login.jsp</result>
    <result name="success" type="redirect">index</result>
</action>

LoginAction.java

public class LoginAction extends ActionSupport {
    public String execute() {
        return SUCCESS;
    }
}

사용자가 만약 http://www.myStruts.com/strutsproject/login 로 요청을 시도하면 Struts에 의해 액션클래스로 지정해놓은 LoginAction 의 execute() 메소드가 호출된다.

excute()의 return 값은 String 형태로 되어있으며, 실행결과에 문제가 없다면 "success"를 돌려주며, index 페이지로 지정된 MainAction을 호출하여 index.jsp로 보낸다.

위와 같이 각각의 동작에 해당되는 자바 클래스를 별도로 작성하고, 웹 페이지와의 관계를 xml로 지정하여 Struts 가 애플리케이션의 동작을 통제한다.

HTML, jsp 에서의 데이터 렌더링

Apache Struts에서는 Java단에서 Getter/Setter를 작성한 후 이에 대한 변수 이름을 Form 필드에 지정만 해주면 HTML이나 jsp의 Form 에서 값을 넘겨줄 때나 받아올 때 추가 코드를 작성할 필요가 없이 Struts가 자동으로 이 메소드들을 호출해서 값을 받아오거나 넘겨준다.

Users.java

@Getter
@Setter
public class Users {
    private String id;
    private String name;
    private int age;

UsersInfoAction.java

public class UsersInfoAction extends ActionSupport {
    private Users users;

    public String execute() {
        users = new Users() ;

        return SUCCESS;
    }

    public Users getUsers() {
        return users;
    }
}

userinfo.jsp 여기서 중요한점은 3번째 line의 Tag 라이브러리 <%@ taglib prefix="s" uri="/struts-tags" %> 를 지정해주는 것이다.

<!DOCTYPE html>
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>User Info</title>
  </head>
  <body>
      <h1>사용자 정보</h1>
      <h3>사용자 아이디</h3>
    <li><s:property value="users.id" /></li>
    <h3>사용자 이름</h3>
    <li><s:property value="users.name" /></li>
    <h3>사용자 나이</h3>
    <li><s:property value="users.age" /></li>
  </body>
</html>

URL 태그 (Forward, Redirect)

HTML은 하이퍼링크를 만드는 간단한 a 태그를 제공하지만, HTML은 종종 중복된 정보를 포함해야하거나 프레임워크에서 제공하는 동적 데이터에 쉽게 Access 하지 못한다.

Struts에서는 이를 해결하기 위해 Struts 2 url 태그를 제공한다.

사용자가 버튼 또는 링크를 클릭하면 Struts 프레임워크 클래스의 실행 메소드를 실행하고 뷰를 렌더링하는 예제를 작성해보았다.

매개변수가 없는 URL 태그

jsp 맨 위에 taglib 지시문 추가 <@ taglib prefix="s" uri="/struts-tags"%>

예제용 jsp 파일 작성

<!DOCTYPE html>
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title>Basic Struts 2 Application - Welcome</title>
    </head>
    <body>
        <h1>Welcome To Struts 2 - Let's Join</h1>
        <p><a href="<s:url action='join'/>">Sign Up</a></p>
    </body>
</html>

struts.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts PUBLIC
        "-//Apache Software Foundation//DTD Struts Configuration 2.5//EN"
        "http://struts.apache.org/dtds/struts-2.5.dtd">
<struts>
    <constant name="struts.devMode" value="true" />

    <package name="basicstruts2" extends="struts-default">
        <action name="index">
            <result>/index.jsp</result>
        </action>

        <action name="join" class="org.apache.struts.strutsproject.action.JoinAction" method="execute">
            <result name="success">/join.jsp</result>
        </action>
    </package>
</struts>

Struts url 태그는 join Action으로 URL을 생성한다. 사용자가 "Sign Up" 링크를 클릭하면 join Action은 클래스 JoinAction의 execute() 메소드를 호출하고, success 문자열을 반환하고, join.jsp 파일이 렌더링된다.

매개변수가 있는 URL 태그

<s:url action="hello" var="helloLink">
  <s:param name="userName">Heera</s:param>
</s:url>

<p><a href="${helloLink}">Click me! Heera</a></p>

url 태그를 <a> 태그의 href 속성의 값으로 넣는 대신, <s:url> 태그를 별도의 코드 블록으로 분리했고, 내부에 <param> 태그를 지정함으로써 파라미터를 지정해줄 수 있다.

문법은 대충 전체적으로 JSTL이나 Thymeleaf 처럼 jsp에 taglib 들을 지정해서 사용하는 문법이 많은 것같고, 문법에 대한 내용이 너무 많아서 더 깊고 자세한 내용들은 그때그때 필요한것 위주로 문서를 찾아봐야겠다.

혹시나 이 글을 보고 struts를 공부하고 있는 사람이 있다면 struts 공식문서를 보고 따라해보길 바란다. 생각보다 쉽고 간단하게 설명이 되어있어 기존에 다른 프레임워크를 사용해본 사람이라면 금방 따라할 것 같다.

Struts 문서 링크 - Getting Started

핵심 라이브러리 Dependency

보통 Maven 기준으로 Apache Struts 버전을 바꿔주면 자동으로 모두 Depedency 된다고 한다. 하지만 기업내부에 배포되어 있는 소스라 알 수 없어 정보 볼 수 있는 곳 링크 걸어놓기 핵심 라이브러리 Dependency 정보

Struts 2 필수 라이브러리 로는

• commons-logging-1.0.4.jar
• freemarker-2.3.8.jar
• ognl-2.6.11.jar
• struts2-core-2.0.11.jar
• xwork-2.0.4.jar

다섯가지가 있고, 버전마다 다르게 추가적으로 에러문구를 보면서 아래 라이브러리도 점검해주고 교체해주면 될 것같다.

• commons.beanutils.1.x.x.jar
• commons.fileupload-1.2.x.jar
• commons.io-1.x.x..jar
• commons-lang3-....jar
• javassist-3....GA.jar
• struts.core1.....jar

다른 블로그를 참고해보니 기존버전의 라이브러리와 업그레이드 할 버전의 라이브러리를 비교하여 이름이 같은것들만 버전을 덮어쓰기하여 맞춰주었더니 해결했다는 글도 있었다. 한번 시도해보면서 trace 해봐야겠다.

🥸 Jenkins Pipeline 구문

JenkinsFile과 Pipeline 구문

Pipeline을 사용하기 위해서는 프로젝트 저장소(git, svn 등)의 JenkinsFile이 작성되어야 한다. 이 JenkinsFile 이 작성되기 위해 선언형 Pipeline 구문 과 스크립트형 Pipeline 구문 2가지를 사용할 수 있다.

선언형 Pipeline 구문이 스크립트형 Pipeline 구문보다 최근에 더 많이 사용되는 방법 이라고 한다.

JenkinsFile

Jenkins 파이프라인은 JenkinsFile 이라는 텍스트 파일을 사용하여 파이프라인을 실행하는 데 필요한 단계를 정의할수있다.

Pipeline 구문

• JenkinsFile을 정의하는 데 사용되는 파이프라인 구문은 선언적 파이프라인 구문과 스크립트 파이프라인 구문 두 가지로 나뉜다. (서로 호환 X)
• 이 두 파이프라인은 모두 Groovy DSL을 기반으로 하지만 스크립트 파이프라인은 조금 더 전통적인 파이프라인이기 때문에 조금 더 엄격한 Groovy 기반 구문을 사용한다.

Pipeline 주요 항목

• pipeline
• node
• stage
• step

pipeline

• pipeline 항목은 애플리케이션의 빌드, 테스트 및 배포 단계를 포함하는 전체 빌드 프로세스를 정의한다.
• pipeline의 블록은 선언형 파이프라인 구문의 핵심 부분이다.
• JenkinsFile의 시작지점에 선언해야 한다.

pipeline { /* 내용 */ }

node

• node 항목은 스크립트형 파이프라인 구문의 핵심 부분이다.
• JenkinsFile의 시작 지점에 선언해야 한다.

node { /* 내용 */ }

stage

• stage 항목은 전체 파이프라인 단계를 통해 수행되는 작업의 하위 집합을 나타낸다. (ex. jenkins를 통해 테스트 -> 빌드 -> 배포 -> 서버 재시작을 수행해야 한다고 가정했을 때 테스트, 빌드, 배포, 서버재시작이 각각 하나의 stage가 된다.)
• stages 항목은 하나 이상의 stage 모음을 정의한다.
• 전체 파이프라인의 흐름에서 특정한 시점에 실행이 필요한 것들을 묶을 수 있다.

stage('build-application-test') {
    steps {
        echo 'Build Start "${TEST_ADMIN}"'
        sh './gradlew --gradle-user-home ${GRADLE_HOME} ${TEST_ADMIN}:clea ${TEST_ADMIN}:build -x test'
        echo 'Build End "${TEST_ADMIN}"'
    }
}

step

• step 항목은 stage 내에서 해야 할 단일 작업을 나타내며, 특정 시점에서 수행할 작업을 알려준다.

stage('build-application-test') {
    steps {
        echo 'Build Start "${TEST_ADMIN}"'
        sh './gradlew --gradle-user-home ${GRADLE_HOME} ${TEST_ADMIN}:clea ${TEST_ADMIN}:build -x test'
        echo 'Build End "${TEST_ADMIN}"'
    }
}

Pipeline 구문 종류

선언형 파이프라인 구문과 스크립트형 파이프라인 구문에 대해 알아보자

선언형 파이프라인 구문

• 파이프라인 코드를 더 쉽게 읽고 쓸 수 있다.
• 이 코드는 git과 같은 소스 제어 관리 시스템에 체크인 할 수 있는 JenkinsFile로 작성된다.

선언형 파이프라인 구문 예시

// Jenkinsfile (Declarative Pipeline)
pipeline {
    agent any // 사용 가능한 agent 에서 이 pipeline 또는 해당 stages를 수행
    stages {
        stage('Build') { // build 단계 정의
            steps {
                echo 'building' // build 단계와 관련된 몇가지 작업 수행
            }
        }
        stage('Test') { // test 단계 정의
            steps {
                echo 'testing' // test 단계와 관련된 몇가지 작업 수행
            }
        }
        stage('Deploy') { // deploy 단계 정의
            steps {
                echo 'deploying' //  deploy 단계와 관련된 몇가지 작업 수행
            }
        }
    }
}

스크립트형 파이프라인 구문

• 선언적 파이프라인 구문보다는 전통적인 방법이다.
• 스크립트 파이프라인 구문에서 JenkinsFile은 Jenkins UI 인스턴스에 작성된다.
• 여기서 stage 블록은 script pipeline 구문에서 선택사항이다. 하지만 stage 블록을 구현하면 Jenkins UI에서 각 작업/단계의 하위 집합을 더 명확하게 시각화 할 수 있다.

스크립트형 파이프라인 구문 예시

// Jenkinsfile (Scripted Pipeline)
node {  // 사용 가능한 agent 에서 이 pipeline 또는 해당 stages를 수행
    stage('Build') { // build 단계를 정의
        echo 'building'// build 단계와 관련된 몇가지 작업 수행
    }
    stage('Test') { // test 단계를 정의
        echo 'testing'// test 단계와 관련된 몇가지 작업 수행
    }
    stage('Deploy') { // deploy 단계를 정의
        echo 'deploying'// deploy 단계와 관련된 몇가지 작업 수행 
    }
}

🥸 선언형 파이프라인(Declarative Pipeline) 구문 문법

선언형 파이프라인을 이용해서 JenkinsFile을 작성하기 위한 문법에 대해 알아보자.

선언형 파이프라인 구문 문법은 Groovy 구문과 동일한 규칙을 따르지만 몇 가지 예외 사항이 있다.

• 시작은 pipeline { } 으로 해야한다.
• 명령문 구분 기호로 세미콜론; 이 없다.
• 블록은 sections, directives, steps 등 할당문으로 구성되어야 한다.
• 속성 참조문은 인자값이 없다. input()

각 옵션에 대한 자세한 정보는 아래 문서를 참고하자 jenkins - pipeline syntax

sections

• sections는 directives 와 steps 를 1개 이상 포함하는 코드로 구성되어 있다.
• sections에 포함된 항목 : agent, post, stages, steps

agent

• pipeline 또는 stage 에서 조건부로 사용할 수 있는 하나의 구간이다.
• 옵션에는 any, none, label, docker, kubernetes 가 있다.

post

• pipeline 또는 stage 에서 조건부로 사용할 수 있는 하나의 구간이다.
• Job의 빌드 이후 처리 동작에 대해 상세 설정을 할 수 있다.
• 옵션에는 always, changed, fixed, regression, aborted, failure, success, unstable, unsuccessful, cleanup가 있다.

stages

• pipeline 또는 stage 에서 조건부로 사용할 수 있는 하나의 구간이다.
• 하나 이상의 stage를 포함한다.
• stage 안에는 여러개의 step이 포함될 수 있다.

steps

• pipeline 또는 stage에서 조건부로 사용할 수 있는 하나의 구간이다.
• 지정된 stage 에서 하나 이상의 step을 정의한다.
• 단일 작업을 나타낸다.

선언형 파이프라인 예시 1

pipeline {
    agent any
    stages {
        stage('Example') {
            steps {
                echo 'Hello World'
                sh ''
            }         
        }     
    }     
    post {
        always {
            echo 'I say always Hello, after perform stages!!'
        }     
       } 
}

선언형 파이프라인 예시 2 - 출처 Jenkins Document

pipeline {
    parameters {
        choice(name: 'PLATFORM_FILTER', choices: ['all', 'linux', 'windows', 'mac'], description: 'Run on specific platform')
    }
    agent none
    stages {
        stage('BuildAndTest') {
            matrix {
                agent {
                    label "${PLATFORM}-agent"
                }
                when { anyOf {
                    expression { params.PLATFORM_FILTER == 'all' }
                    expression { params.PLATFORM_FILTER == env.PLATFORM }
                } }
                axes {
                    axis {
                        name 'PLATFORM'
                        values 'linux', 'windows', 'mac'
                    }
                    axis {
                        name 'BROWSER'
                        values 'firefox', 'chrome', 'safari', 'edge'
                    }
                }
                excludes {
                    exclude {
                        axis {
                            name 'PLATFORM'
                            values 'linux'
                        }
                        axis {
                            name 'BROWSER'
                            values 'safari'
                        }
                    }
                    exclude {
                        axis {
                            name 'PLATFORM'
                            notValues 'windows'
                        }
                        axis {
                            name 'BROWSER'
                            values 'edge'
                        }
                    }
                }
                stages {
                    stage('Build') {
                        steps {
                            echo "Do Build for ${PLATFORM} - ${BROWSER}"
                        }
                    }
                    stage('Test') {
                        steps {
                            echo "Do Test for ${PLATFORM} - ${BROWSER}"
                        }
                    }
                }
            }
        }
    }
}

Jenkins 기초 설정

Unlock Jenkins

우선 Jenkins의 첫 화면이 이렇게 나올것인데, 설치 시 받았던 Hash 값을 넣어주면 된다.

최초 비밀키 알아내는 방법

admin을 발급받기 위한 임시 비밀번호이다. 이 key를 입력해주면 된다.

$ sudo docker logs -f jenkins

Jenkins 설치 시 제안되는 플러그인 설치

Jenkins를 설치할 때 Jenkins가 사용자에게 추천하는 플러그인 목록이다. Jenkins를 시작하고 기본적인 작업을 수행하는 데 도움이 되는 플러그인이 포함된다. Install suggested plugins 를 누른다.

바로 자동으로 설치가 된다.

Admin 계정 설정

해당 이메일 주소는 봇같은 것을 연동하거나 할땐 그 이메일주소를 넣어주는 것이 좋다.

Jenkins URL 설정

이 주소가 맞냐고 확인하는 과정이다. Save를 해준다.

완료

기초 가이드

Ubuntu Shell에서 Jenkins Shell로 접속하기

$ sudo docker exec -it jenkins /bin/bash

나올때는 exit 명령어로 하면된다.

$ exit

Ubuntu Shell에서 Jenkins Shell로 파일 복사하기

$ sudo docker cp script.sh jenkins:/tmp/script.sh

docker cp를 이용하여 script.sh 파일을 jenkins라는 컨테이너의 /tmp/script.sh 경로로 파일을 복사하겠다는 뜻이다.

권한 정보까지 복사가 잘 된것을 확인할 수 있다.

DSL로 Job 생성하기

DSL을 이용하여 Job을 생성하는 것을 Seed Job 이라고 한다. 일반 프로젝트와 큰 차이점은 없으나 이 Job에서 작성한 템플릿을 통해 다른 Job들이 생성되는 것이 특징이다.

1. Jenkins 관리 > Plugins 탭으로 가서 Job DSL Plugin을 설치해준다.

2. New Item 으로 가서 Freestyle project를 생성해준다.

3. github 정보 입력

간단히 index 페이지를 띄워주는 샘플 소스를 생성해서 git에 올려두었다.

branch 정보를 넣어준다.

4. build step 추가

Process Job DSLs 를 선택하여 추가하여준다.

5. dsl samplescript 추가

테스트 용이니 샘플로 추가해주었다. jenkins dsl-job 여기 젠킨스 문서를 참고하자!

Use the provided DSL script 는 DSL script를 추가하겠다는 의미이다.

steps는 빌드 단계를 의미한다. 빌드를 할때마다 echo Hello world! 를 하겠다는 의미이다.

이 단계에서 스케줄링을 설정할 수도 있다.

저장을 해준다.

6. dsl script 보안을 비활성화 해준다.

Jenkins 관리 > Security > Enable script security for Job DSL script 체크박스를 해제해준다.

7. 빌드를 해준다.

script가 적용된 모습을 볼 수 있다.

저번 포스팅에서 AWS를 이용한 Linux를 구성했고, Ubuntu에서 Docker와 Docker Compose를 구성해보았다. 이번에는 파이프라인(pipeline)의 핵심인 Jenkins를 구성 해보도록 하자.

🥸 Install Jenkins

우선 Docker Hub에 접속하여 Jenkins Image 파일을 찾아보도록 하자.

Docker Hub

Jenkins Image 파일

맨 위에 있는 Jenkins는 이미 DEPRECATED(End of Service)가 되어 있으며 6년전 이 마지막 업데이트 이기 때문에 두번째의 jenkins/jenkins를 선택해주었다.

Docker Pull Command로 간단하게 실행해서 컨테이너 이미지를 불러오는 방법이 있고, docker-compose를 활용하여 image에 대한 정보를 작성 후에 실행시켜 컨테이너 이미지를 띄우는 방법이 있다.

Docker Pull 방법은 간편하지만 실행할 때마다 port와 같은 정보들을 하나하나 입력해주어야 하는 불편함이 있다. Docker Compose 방식은 나중에 다른 시스템과 통합하기에도 편하고 유지보수에도 더 도움이 되기 때문에 docker-compose를 이용한 방식이 조금 더 권장된다.

나는 docker-compose를 활용한 방식을 사용해보겠다.

1. docker compose 작성 및 image 구동을 위한 폴더 생성

/ root 경로로 가서, docker라는 폴더를 생성해줄것이다. 그리고 그 안에 /docker/jenkins/jenkins_home/ 이라는 폴더도 생성해줄 것이다.

$ cd /
$ sudo mkdir docker
$ cd docker
$ sudo mkdir jenkins
$ cd jenkins
$ sudo mkdir jenkins_home
$ cd /
$ sudo chown 1000:1000 docker/ -R

2. docker-compose.yml 작성

$ cd /docker/jenkins/jenkins_home
$ vi docker_compose.yml

version: '3'
services:
    jenkins:
        container_name: jenkins # process name
        image: jenkins/jenkins  # jenkins/jenkins packaging version을 받겠다.
        ports:
          - "8080:8080" # port forwading
        volumes:
          - "/docker/jenkins/jenkins_home:/var/jenkins_home" # ubuntu 경로와 docker 경로
        networks:
          - net
networks:
    net:

3. docker-compose로 docker-compose.yml up 하기

이 과정을 통해 Docker Compose는 docker-compose.yml안에 정의된 모든 서비스를 시작한다.

$ sudo docker compose up -d

*4. 최초 비밀키 알아내기 *

admin을 발급받기 위한 임시 비밀번호이다. 확인하고 어딘가에 잘 복붙해 둔다.

$ sudo docker logs -f jenkins

Docker에 image가 정상적으로 실행 되었는지 확인

docker ps는 실행중인 image를 나열하는 것이고, -a(all) 옵션이 붙으면 중지된 컨테이너 까지 모두 확인하는 명령어다.

$ docker ps

Jenkins Image 접속하기

방화벽 체크

docker를 구동시킨 8080에 접속을 하면 되어야 하는데 아무것도 연결되지 않는다. 이것은 방화벽을 체크하고 열어주어야 한다.

1. AWS EC2 Instance 관리에 간다.

Instance를 체크하고, 보안 탭에서 보안그룹으로 들어간다.

2. 인바운드 규칙을 설정해준다.

• 인바운드(Inbound)란? 머신으로 들어오는 트래픽
• 아웃바운드(Outbound)란? 머신에서 나가는 트래픽

인바운드 규칙 편집을 눌러준다.

SSH는 그대로 두고, 8080포트를 허용하기 위해 사용자지정 TCP를 선택해준다.

포트는 8080으로 하고, 소스는 DB와 같은 보안이 중요한 리소스를 보호하기 위해 접속할 수 있는 IP들을 제한할 수 있는 것인데 나는 어떤 IPv4든 접속이 가능하도록 Anywhere-IPv4를 선택 해 주었다. 그리고 규칙 저장을 눌러준다.

결과

기존 Spring에서는 자바 코드의 @Bean이나, xml파일의 <bean> 태그 등을 통해서 직접 등록할 스프링 빈을 나열했다. 실무에서는 코드가 수십, 수백개가 될텐데 이 Bean들을 모두 일일히 등록해주려면 귀찮기도하고 실제로 누락되는 정보도 많을 것이다.

그래서 Spring은 설정 정보가 없어도 자동으로 Spring Bean을 등록해주는 @ComponentScan 기능을 제공한다.

@ComponentScan Annotation은@Component 및 @Controller, @Service, @Repository, @Configuration 등 과 같은 Annotation을 스캔하여 해당 Annotation이 부여된 Class(객체)들을 자동으로 Scan하여 스프링 빈(Bean)에 등록 해주는 역할을 한다.

그리고 @Autowired를 통해 의존 관계도 자동으로 주입(Dependency Injection)해준다.

@ComponentScan

@ComponentScan 을 지정할 파일 위치

@ComponentScan Annotation은 따로 basePackages를 지정해 주지 않는 이상 자기가 위치한 곳부터 패키지 아래의 모든 @Component와 @Controller, @Service, @Repository, @Configuration와 같은 Annotation 들을 Scan하여 객체를 @Bean으로 등록해준다.

그렇기 때문에 패키지의 가장 바깥쪽에 위치하는 곳에 두고 Scan을 한다.

@ComponentScan을 적용한 예시

@Configuration
@ComponentScan
public class AppConfig {

}

@ComponentScan 내 Scan 패키지 범위 지정하기

basePackages 를 이용하면 탐색할 패키지의 시작 위치를 지정할 수 있다. basePackages에 지정한 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.

com.kyh.heera.member 패키지와 그 하위 패키지 내 @Component 객체 Scan하기

@ComponentScan(
          basePackages = "com.kyh.heera.member",
}

@Component와 같은 Annotation을 Scan 할 수 있는 이유

@ComponentScan은 말 그대로 @Component Annotation이 붙은 Class를 Scan해서 스프링에 Bean으로 등록한다.

@Controller, @Service, @Repository, @Configuration와 같은 Annotation들을 들어가보면 @Component가 등록되어 있는 것을 확인할 수 있다.

@Controller Annotation 내부

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Controller {

    /**
     * Alias for {@link Component#value}.
     */
    @AliasFor(annotation = Component.class)
    String value() default "";

}

@Service Annotation 내부

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Service {

    /**
     * Alias for {@link Component#value}.
     */
    @AliasFor(annotation = Component.class)
    String value() default "";

}

@Repository Annotation 내부

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Repository {

    /**
     * Alias for {@link Component#value}.
     */
    @AliasFor(annotation = Component.class)
    String value() default "";

}

@Configuration Annotation 내부

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {

    @AliasFor(annotation = Component.class)
    String value() default "";

    boolean proxyBeanMethods() default true;
    boolean enforceUniqueMethods() default true;
}

Bean 등록 테스트

package com.kyh.heera.scan;

import com.kyh.heera.AutoAppConfig;
import com.kyh.heera.member.MemberRepository;
import com.kyh.heera.member.MemberService;
import com.kyh.heera.order.OrderServiceImpl;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import static org.assertj.core.api.Assertions.assertThat;

public class AppConfigTest {

    @Test
    void basicScan() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);

        OrderServiceImpl bean = ac.getBean(OrderServiceImpl.class);
        MemberRepository memberRepository = bean.getMemberRepository();

        System.out.println("memberRepository = " + memberRepository);
    }

}

Test 결과

@Autowired

@Autowired를 지정하면, Spring Container가 해당 스프링 빈을 찾아서 주입한다. 참고로 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 Bean이어야 동작한다. Member와 같은 DTO에서 @Autowired 코드를 적용해도 아무 기능도 동작하지 않는다.

기본적으로 Type 기반으로 조회를 하며, 여러 빈이 있다면 필드이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.

@Autowired는 4가지의 경우에 적용할 수 있다.

• Constructor(생성자)
• setter(수정자)
• field(필드)
• method(메소드)

Constructor(생성자)

생성자 주입은 생성자에 의존성 주입을 받고자 하는 field를 나열하는 방법으로, 3가지 경우 중 가장 권고되는 방법이다.

특징

• 생성자 호출 시점에 딱 1번만 호출되는 것이 보장된다.
• 불변이 보장된다.
• 생성자를 호출(=객체를 호출) 하는 시점에 Bean이 생성되기 때문에 필수적인 의존관계에 사용된다.
• 생성자가 딱 1개 있다면 @Autowired를 생략해도 자동 주입된다.

Constructor(생성자) 주입 예시

@Component
  public class OrderServiceImpl implements OrderService {

      private final MemberRepository memberRepository;
      private final DiscountPolicy discountPolicy;

      @Autowired // 이렇게 생성자가 딱 하나만 있다면 생략 가능
      public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
  discountPolicy) {
          this.memberRepository = memberRepository;
          this.discountPolicy = discountPolicy;
      }
}

setter(수정자)

수정자 주입은 setter라 불리는 field의 값을 변경하는 수정자 Method를 통해 의존관계를 주입하는 방법이다.

특징

• 선택적으로 의존성을 주입해야 하는 경우 사용한다.
• 변경 가능성이 있는 의존관계에 사용한다.

참고 _선택적으로 의존성을 주입할 경우에 @Autowired의 기본동작은 주입할 대상이 없으면 오류가 발생하기 때문에 @Autowired(required=false) 와 같은 옵션을 추가해주어야 한다. _

setter(수정자) 주입 예시

@Component
  public class OrderServiceImpl implements OrderService {

      private MemberRepository memberRepository;
      private DiscountPolicy discountPolicy;

        @Autowired
        public void setMemberRepository(MemberRepository memberRepository) {
            this.memberRepository = memberRepository;
        }
        @Autowired
        public void setDiscountPolicy(DiscountPolicy discountPolicy) {
            this.discountPolicy = discountPolicy;
        }

}

field(필드)

필드에 바로 주입하는 방식이다. 예전에 나도 많이 사용했었지만, 지금은 권장하지 않는다고 한다.

특징

• 코드가 간결해서 많이 사용되었다.
• 외부에서 변경이 불가능(private keyword 등)하기 때문에 테스트하기 힘들다는 치명적인 단점이 있다.
• DI(Dependency Injection) 프레임워크가 없으면 아무것도 할 수 없다.

field(필드) 주입 예시

@Component
  public class OrderServiceImpl implements OrderService {

        @Autowired
        private MemberRepository memberRepository;

        @Autowired
        private DiscountPolicy discountPolicy;

}

method(메소드)

일반 method(메소드)를 통해서 주입 받을 수 있다.

특징

• 한번에 여러 필드를 주입 받을 수 있다.
• 일반적으로 잘 사용하지 않는다.

method(메소드) 주입 예시

@Component
public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

    @Autowired
    public void init(MemberRepository memberRepository, DiscountPolicy
    discountPolicy) {
            this.memberRepository = memberRepository;
            this.discountPolicy = discountPolicy;
        }
}