쏘니의 개발블로그

Flutter에서 UI를 코드로 작성하는 것이 기본이지만, 최근에는 UI를 시각적으로 구성할 수 있는 도구들도 발전하고 있습니다.

이러한 도구를 사용하면 코드를 직접 작성하지 않고도 쉽게 화면을 디자인할 수 있습니다. 가장 많이 사용되는 도구는 다음과 같습니다.

1. Flutterflow

Flutterflow는 웹 기반의 Flutter 앱 빌더로, 드래그 앤 드롭 방식으로 UI를 구성할 수 있습니다. Flutter 코드를 자동으로 생성해주며, Firebase와의 통합도 지원합니다.

• Flutterflow 웹사이트: https://flutterflow.io/

2. Codemagic

Codemagic은 CI/CD 도구이지만, UI 구성 요소를 시각적으로 디자인할 수 있는 기능도 제공하며, 이를 통해 Flutter 프로젝트를 빌드하고 배포할 수 있습니다.

• Codemagic 웹사이트: https://codemagic.io/start/

3. Adobe XD 플러그인

Adobe XD에는 Flutter 플러그인이 있어, Adobe XD에서 디자인한 UI를 Flutter 코드로 변환할 수 있습니다.

• Adobe XD: 디자인 도구로서 UI를 설계한 후, Flutter 플러그인을 통해 코드로 변환합니다.
• Flutter 플러그인 설치: Adobe XD의 플러그인 마켓에서 Flutter 플러그인을 설치합니다.

4. Android Studio의 Flutter UI Inspector

Android Studio의 Flutter 플러그인에는 Flutter UI Inspector 기능이 있습니다. 이 도구를 사용하면 기존 UI를 시각적으로 검사하고, 수정할 수 있습니다.

예제: Flutterflow를 사용한 UI 디자인

Flutterflow를 사용하여 간단한 UI를 디자인하고 Flutter 프로젝트에 통합하는 방법을 설명하겠습니다.

1. Flutterflow에 가입 및 프로젝트 생성

1. flutterflow.io에 가입합니다.
2. 새로운 프로젝트를 생성합니다.

2. UI 디자인

1. Flutterflow의 드래그 앤 드롭 인터페이스를 사용하여 UI를 구성합니다.
2. 필요한 위젯을 캔버스로 끌어다 놓고, 속성을 설정합니다.

3. Flutter 프로젝트로 내보내기

1. 디자인이 완료되면 Export Code 옵션을 사용하여 Flutter 코드를 다운로드합니다.
2. 생성된 Flutter 프로젝트를 Android Studio에서 엽니다.

4. Android Studio에서 프로젝트 실행

1. main.dart 파일을 열고, runApp 함수를 실행하여 앱을 시작합니다.
2. Flutterflow에서 생성된 코드는 기존 Flutter 프로젝트와 동일한 방식으로 동작합니다.

이와 같은 도구를 사용하면 시각적으로 UI를 구성하고, 이를 Flutter 코드로 변환할 수 있습니다. 이렇게 하면 코드 작성을 최소화하고도 효율적으로 UI를 구성할 수 있습니다.

플러터 예시 및 자료

1. Flutter 공식 문서

Flutter의 공식 문서에는 다양한 위젯과 레이아웃, 애니메이션, 상태 관리 등 Flutter로 UI를 구축하는 데 필요한 모든 정보가 포함되어 있습니다.

• Flutter Widget Catalog: 다양한 위젯의 사용법과 예제 코드가 제공됩니다.

• Flutter Layouts: 레이아웃을 구성하는 방법에 대해 자세히 설명합니다.

2. Flutter 유튜브 채널

Flutter의 공식 유튜브 채널에는 Flutter를 사용한 다양한 UI 구현 예제와 튜토리얼이 포함되어 있습니다. 특히 “Widget of the Week” 시리즈는 각 위젯의 사용법을 짧고 간단하게 설명합니다.

• Flutter YouTube Channel

3. 블로그와 튜토리얼 사이트

다양한 블로그와 튜토리얼 사이트에서 Flutter UI 구현 방법을 단계별로 배울 수 있습니다.

• Medium: Flutter 태그를 통해 많은 개발자들이 작성한 블로그 글을 읽을 수 있습니다.

• Ray Wenderlich: Flutter 튜토리얼과 예제가 잘 정리되어 있습니다.

4. GitHub 예제 코드

GitHub에는 많은 Flutter 예제 프로젝트가 있습니다. 실제 프로젝트 코드를 보면서 학습할 수 있습니다.

• Awesome Flutter: 다양한 Flutter 라이브러리와 예제 프로젝트를 모아놓은 레포지토리입니다.

• Flutter Samples: Flutter 팀이 직접 관리하는 다양한 예제 프로젝트가 포함되어 있습니다.

5. Flutter 인터랙티브 코드랩

Flutter 공식 사이트에서 제공하는 코드랩을 통해 직접 코드를 작성해보며 학습할 수 있습니다.

• Flutter Codelabs: 단계별로 진행되는 튜토리얼을 통해 Flutter의 다양한 기능을 실습할 수 있습니다.

설정 > 휴대전화 정보 > 빌드번호 > 7번 클릭

1. .dart_tool

• Dart 도구와 패키지 관리자(pub)의 관련 데이터를 저장합니다. 일반적으로 직접 수정할 필요는 없습니다.

2. .idea

• IntelliJ IDEA 및 Android Studio와 관련된 프로젝트 설정 파일을 포함합니다. 역시 직접 수정할 필요는 없습니다.

3. android

• Android 애플리케이션과 관련된 파일과 설정을 포함합니다. AndroidManifest.xml, build.gradle 파일 등이 있습니다. Android 플랫폼에 특화된 설정이나 코드가 필요할 때 이 디렉터리를 수정합니다.

4. build

• 프로젝트 빌드 시 생성되는 파일들이 저장됩니다. 이 디렉터리는 버전 관리 시스템(git)에서 제외하는 것이 일반적입니다.

5. ios

• iOS 애플리케이션과 관련된 파일과 설정을 포함합니다. Info.plist, AppDelegate.swift 파일 등이 있습니다. iOS 플랫폼에 특화된 설정이나 코드가 필요할 때 이 디렉터리를 수정합니다.

6. lib

• Flutter 애플리케이션의 Dart 코드가 저장되는 곳입니다. main.dart 파일이 위치해 있으며, 애플리케이션의 주요 로직과 UI를 구현합니다. 실제 개발 작업의 대부분이 이 디렉터리에서 이루어집니다.

7. linux

• Linux 데스크톱 애플리케이션과 관련된 파일과 설정을 포함합니다. Linux 플랫폼에 특화된 설정이나 코드가 필요할 때 이 디렉터리를 수정합니다.

8. macos

• macOS 데스크톱 애플리케이션과 관련된 파일과 설정을 포함합니다. macOS 플랫폼에 특화된 설정이나 코드가 필요할 때 이 디렉터리를 수정합니다.

9. test

• 테스트 코드가 저장되는 디렉터리입니다. Flutter는 기본적으로 unit test와 widget test를 지원하며, 테스트 코드는 이 디렉터리에 작성합니다.

10. web

• 웹 애플리케이션과 관련된 파일과 설정을 포함합니다. 웹 플랫폼에 특화된 설정이나 코드가 필요할 때 이 디렉터리를 수정합니다.

11. windows

• Windows 데스크톱 애플리케이션과 관련된 파일과 설정을 포함합니다. Windows 플랫폼에 특화된 설정이나 코드가 필요할 때 이 디렉터리를 수정합니다.

12. .gitignore

• Git 버전 관리 시스템에서 추적하지 않을 파일과 디렉터리를 정의합니다.

13. .metadata

• 프로젝트의 메타데이터를 저장하는 파일입니다. 일반적으로 직접 수정할 필요는 없습니다.

14. analysis_options.yaml

• Dart 분석 옵션을 설정하는 파일입니다. 코드 스타일 및 규칙을 정의할 수 있습니다.

15. flutter_app.iml

• IntelliJ 프로젝트 파일입니다. 일반적으로 직접 수정할 필요는 없습니다.

16. pubspec.lock

• 프로젝트에 사용되는 패키지의 버전이 기록된 파일입니다. pub get 명령어로 생성되며, 패키지 버전 관리를 돕습니다.

17. pubspec.yaml

• Flutter 프로젝트의 구성 파일입니다. 프로젝트의 종속성, 자산, 패키지 등을 정의합니다. 새로운 패키지를 추가하거나 설정을 변경할 때 이 파일을 수정합니다.

18. README.md

• 프로젝트에 대한 설명을 제공하는 파일입니다. 프로젝트의 목적, 설치 방법, 사용법 등을 문서화합니다.

lib>main.dart 

파일이 앱의 시작점

에뮬레이터 실행

우측 상단에 Device Manager 클릭

create virtual device 로 원하는 기종선택 가능합니다.

기종 선택시 참고사항

추천 기종 선택

1. Pixel 7 Pro 또는 Pixel 7

• 최신 안드로이드 버전을 지원하며, 다양한 화면 크기와 해상도를 테스트할 수 있습니다.

• 일반적으로 개발자들이 많이 사용하는 기종으로 호환성 테스트에 유리합니다.

2. Pixel 8 또는 Pixel 8 Pro

• 최신 모델로 최신 안드로이드 기능을 테스트할 수 있습니다.

• 해상도와 화면 크기가 다양하여 UI 테스트에 유리합니다.

3. Pixel Fold

• 폴더블 기기 특성상 화면 전환 및 반응형 디자인 테스트에 유리합니다.

• 폴더블 기기에서의 사용자 경험을 확인할 수 있습니다.

선택 기준

• 목적: 만약 폴더블 기기나 특수한 해상도에서의 테스트가 필요하다면 Pixel Fold 같은 기기를 선택합니다.

• 일반적인 테스트: 일반적인 앱 테스트를 원한다면 Pixel 7 Pro나 Pixel 8 Pro를 선택합니다.

• 최신 기종: 항상 최신 기종을 선택하면 최신 OS 버전에서의 동작을 확인할 수 있습니다.

예시 선택

• Pixel 7 Pro: 안정적이고 일반적인 테스트에 적합합니다.

• Pixel 8 Pro: 최신 기능과 고해상도 화면을 지원하여 세부적인 UI 테스트에 유리합니다.

시스템 이미지 선택 

 최신 버전인 **API Level 35 (Android 14)**의 Google Play 이미지를 사용하는 것이 좋습니다. 이는 최신 기능과 안정성을 테스트할 수 있으며, 새로운 안드로이드 버전의 호환성을 확인하는 데 도움이 됩니다.

에뮬이 세팅 되었다면 device 선택 후 실행 버튼을 눌러줍니다.

안드로이드 스튜디오 다운 링크

https://developer.android.com/studio?gad_source=1&gclid=CjwKCAjwnK60BhA9EiwAmpHZw8fNEnrne2ansIdcGTLxs6sy03elCeOiHOHncwj4lX5mJYvKtfJW1xoCiBEQAvD_BwE&gclsrc=aw.ds

본인 컴퓨터의 버젼에 맞는 안드로이드 스튜디오를 다운 받습니다.

standard 로 진행합니다.

각 항목별로 accept 를 진행합니다.

finish 로 다음 다운을 진행합니다.

프로젝트 시작화면이 나올텐데 여기서 좌측 plugins 를 선택 후 flutter 을 install 합니다.

설치 완료 후 ide 를 다시시작해 업데이트를 적용합니다.

처음 실행한다면 android sdk 가 깔려있지 않기 때문에 more acions 로 sdk 를 깔아줍니다.

sdk manager 를 클릭해 줍니다. 

android sdk command-line Tools(latest) 를 체크하고 다운 받아 줍니다.

android 를 설치한다고 flutter sdk가 설치되는 것은 아닙니다. 추가로 설치해주어야 합니다.

Flutter SDK 설치 및 설정

1. Flutter SDK 다운로드

Flutter 공식 웹사이트에서 SDK를 다운로드합니다.

https://docs.flutter.dev/get-started/install

내 os 에 맞는 아이콘을 선택해 줍니다.

1. Desktop: 데스크톱 앱을 개발하려는 경우 선택하세요.

2. iOS: iOS 앱을 개발하려는 경우 선택하세요. 만약 iOS와 Android 둘 다 개발할 계획이라면 iOS를 선택하는 것이 좋습니다.

3. Android: Android 앱을 개발하려는 경우 선택하세요.

4. Web: 웹 애플리케이션을 개발하려는 경우 선택하세요.

윈도우 설치 

https://docs.flutter.dev/release/archive?tab=windows

환경변수 등록 

윈도우의 경우

 

 

환경변수 페이지에서 flutter 환경 변수를 추가합니다.

 Path 누르고 편집을 누릅니다.

 

 

 

 

▲ 새로만들기를 눌러서 님이 아까 압축푼 Flutter폴더 안의 bin 폴더의 풀 경로를 적어줍니다.

 

 

 

 

 

맥설치 

os 에 맞는 zip 파일 다운받은 후 설치 원하는 경로에 들어가서 아래 unzip 으로 압축을 풀어주면 flutter 라는 폴더 생성이 됩니다.

unzip ~/Downloads/flutter_macos_arm64_3.22.2-stable.zip 

flutter 를 다운받아주고 이를 컴퓨터 환경변수에 넣어줘야 한다.

https://docs.flutter.dev/get-started/install/macos/mobile-ios?tab=download#add-flutter-to-your-path

파일 생성

touch ~/.zshenv

파일 수정

open ~/.zshenv

아래 development 에는 본인이 설치한 경로를 넣어줍니다.

export PATH=$HOME/development/flutter/bin:$PATH

맥, 윈도우 공통 설치 과정

다시 안드로이드 스튜디오가 flutter 를 인식할수 있도록 작업을 해줍니다. 

New Flutter Project 라는 걸 클릭해줍니다. 

sdk path 를 우리가 다운받아준 경로로 설정해줍니다. 

NEXT 로 진행해줍니다. 

app name 및 설정을 입력해 주고 create 를 통해 프로젝트 생성해 줍니다. 

AWS CloudWatch Logs 에이전트를 설치하고 구성하는 방법은 다음 단계에 따라 진행할 수 있습니다. 이 과정에서는 EC2 인스턴스에서 로그를 수집하고 CloudWatch Logs로 전송하는 방법을 설명합니다.

1. AWS CloudWatch Logs 에이전트 설치

단계 1: 에이전트 설치

1. EC2 인스턴스에 SSH로 접속합니다.

2. 다음 명령어를 실행하여 CloudWatch Logs 에이전트를 다운로드하고 설치합니다.

Amazon Linux 및 Amazon Linux 2:

wget https://s3.amazonaws.com/amazoncloudwatch-agent/amazon_linux/amd64/latest/amazon-cloudwatch-agent.rpm
sudo rpm -U ./amazon-cloudwatch-agent.rpm

Ubuntu:

wget https://s3.amazonaws.com/amazoncloudwatch-agent/ubuntu/amd64/latest/amazon-cloudwatch-agent.deb
sudo dpkg -i -E ./amazon-cloudwatch-agent.deb

단계 2: CloudWatch Agent 구성

sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-config-wizard

구성 마법사를 완료한 후, 생성된 구성 파일을 /opt/aws/amazon-cloudwatch-agent/etc/amazon-cloudwatch-agent.json에 저장합니다.

sudo vi /opt/aws/amazon-cloudwatch-agent/etc/amazon-cloudwatch-agent.json

{
    "logs": {
        "logs_collected": {
            "files": {
                "collect_list": [
                    {
                        "file_path": "/var/log/my-app/output.log",
                        "log_group_name": "/my-app/output",
                        "log_stream_name": "{instance_id}-output"
                    },
                    {
                        "file_path": "/var/log/my-app/error.log",
                        "log_group_name": "/my-app/error",
                        "log_stream_name": "{instance_id}-error"
                    }
                ]
            }
        }
    }
}

여기서

file_path 는 클라우드와치에 보내고 싶은 서버 로컬 파일 경로를 적어줍니다.

instance_id 는 EC2 대시보드에 id 가 적혀있습니다.

또 log_group_name 이라는 클라우드 와치 내 logs 그룹을 추가해줘야 합니다.

터미널에서 아래 코드를 실행해 줘야 하는데 아마 권한때문에 안될겁니다. IAM 을 계정을 추가하고 서버 로컬에서 로그인 해줘야 합니다.

aws logs create-log-group --log-group-name /my-app/output --region ap-northeast-2
aws logs create-log-group --log-group-name /my-app/error --region ap-northeast-2

IAM 콘솔 

IAM 권한 확인 및 설정

IAM 사용자 또는 역할에 필요한 권한이 있는지 확인합니다. IAM 콘솔에서 다음 정책을 추가하십시오.

1. AWS Management Console에 로그인합니다.

2. 상단 메뉴에서 **“Services”**를 클릭하고, **“IAM”**을 선택합니다.

3. 왼쪽 메뉴에서 **“Users”**를 클릭합니다.

4. ablelearn 사용자를 클릭합니다.

5. “Add permissions” 버튼을 클릭합니다.

6. **“Attach policies directly”**를 선택합니다.

7. 검색창에 CloudWatchLogsFullAccess를 입력하고, 해당 정책을 선택합니다.

8. **“Next: Review”**를 클릭한 후 **“Add permissions”**를 클릭합니다.

또한 user 에 role 을 부여하고 EC2 인스턴스에 역할을 부여해 주어야 합니다. 

1. AWS Management Console에 로그인합니다.

2. IAM 콘솔로 이동합니다.

3. 왼쪽 메뉴에서 Roles를 선택합니다.

4. Create role을 클릭합니다.

5. AWS 서비스를 선택하고, EC2를 선택한 후 Next: Permissions를 클릭합니다.

6. CloudWatchLogsFullAccess 정책을 선택하고 Next: Tags를 클릭합니다.

7. Next: Review를 클릭합니다.

8. 역할 이름을 입력하고 Create role을 클릭합니다.

EC2 인스턴스에 IAM 역할 부여

1. EC2 콘솔로 이동합니다.

2. 대상 인스턴스를 선택하고 Actions -> Security -> Modify IAM role을 클릭합니다.

3. 방금 생성한 IAM 역할을 선택하고 Update IAM role을 클릭합니다.

EC2 인스턴스에 IAM 역할 부여

1. EC2 콘솔로 이동합니다.

2. 대상 인스턴스를 선택하고 Actions -> Security -> Modify IAM role을 클릭합니다.

3. 방금 생성한 IAM 역할을 선택하고 Update IAM role을 클릭합니다.

AWS CLI 설정 (Optional)

로컬에서 AWS CLI를 통해 자격 증명을 설정할 수 있습니다.

aws configure

AWS Access Key ID [None]: YOUR_ACCESS_KEY_ID
AWS Secret Access Key [None]: YOUR_SECRET_ACCESS_KEY
Default region name [None]: ap-northeast-2
Default output format [None]: json

여기서 Access Id 와 key 는 IAM user 계정 생성시 발급 됩니다.

user 및 role 이 정상적으로 생성했다면 

아래 코드를 실행합니다. 

sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl -a fetch-config -m ec2 -c file:/opt/aws/amazon-cloudwatch-agent/etc/amazon-cloudwatch-agent.json -s

파일 실행 하면 

sudo vi /opt/aws/amazon-cloudwatch-agent/etc/amazon-cloudwatch-agent.json 
파일은 없어지므로 다시 재실행할때 다시 json 파일을 생성해주면 됩니다. 

에이전트가 오류가 있는지 디버깅을 하기위해서는 아래와 같이 로그를 확인할 수 있습니다.

sudo tail -f /opt/aws/amazon-cloudwatch-agent/logs/amazon-cloudwatch-agent.log

systemctl 에서 에이전트가 러닝인지 종료인지 알기 위해서는 아래 명령어로 확인 가능합니다.

sudo systemctl status amazon-cloudwatch-agent

보통 대부분의 이슈는 user 및 role 권한 설정이슈입니다. 

정상적으로 동작한다면

각 그룹에서 로그가 적재된걸 확인할 수 있습니다. 
서버 로컬에서 log group 을 생성을 하고 위 대시보드에서 확인바랍니다.

요약

• amazon-cloudwatch-agent.json 파일을 편집하여 EC2 모드를 설정합니다.

• 구성 파일을 저장하고 CloudWatch Agent를 다시 시작합니다.

• 로그 그룹이 존재하는지 확인하고, 필요 시 생성합니다.

• IAM 사용자 또는 역할에 필요한 권한을 확인합니다.

• CloudWatch Agent 로그 파일을 확인하여 추가적인 디버깅 정보를 얻습니다.

• CloudWatch 콘솔에서 로그 그룹을 확인합니다.

이전포스팅
https://juntcom.tistory.com/252

AWS CloudWatch는 보고서 작성 기능을 포함한 다양한 모니터링 및 관리 기능을 제공합니다. 구체적으로는 CloudWatch Logs Insights와 CloudWatch Dashboards를 사용하여 데이터를 시각화하고 보고서를 작성할 수 있습니다.

클라우드와치 구성 종류는 크게 두가지로 나눌 수 있습니다.

1. CloudWatch Logs Insights

CloudWatch Logs Insights는 로그 데이터를 쿼리하고 분석할 수 있는 강력한 도구입니다. 이를 통해 특정 기간 동안의 로그 데이터를 기반으로 다양한 보고서를 생성할 수 있습니다.

• 로그 쿼리 작성: SQL과 유사한 쿼리 언어를 사용하여 로그 데이터를 분석할 수 있습니다.

• 쿼리 결과 시각화: 쿼리 결과를 그래프로 시각화할 수 있으며, 이를 기반으로 대시보드를 구성할 수 있습니다.

• 저장 및 공유: 쿼리 결과를 저장하고 다른 사용자와 공유할 수 있습니다.

2. CloudWatch Dashboards

CloudWatch Dashboards를 사용하면 여러 지표와 로그 데이터를 한 곳에서 시각화하여 보고서를 생성할 수 있습니다.

• 대시보드 생성: 다양한 위젯을 사용하여 사용자 정의 대시보드를 만들 수 있습니다.

• 실시간 모니터링: 실시간으로 데이터를 시각화하여 시스템 상태를 모니터링할 수 있습니다.

• 공유 및 액세스 제어: 대시보드를 공유하고 액세스 권한을 설정할 수 있습니다.

CloudWatch 대시보드 생성

1. AWS Management Console에 로그인합니다.

2. CloudWatch 콘솔로 이동합니다.

3. 왼쪽 메뉴에서 **“Dashboards”**를 선택하고 **“Create dashboard”**를 클릭합니다.

4. 대시보드 이름을 입력하고 **“Create dashboard”**를 클릭합니다.

Automatic dashboards 로 대시보드를 생성한다면 각종 지표를 종합적으로 대시보드에 구성해 줍니다. 

Ec2 지표 대시보드 

5. 한개씩 지표 설정을 하고 싶다면  Custom Datshboard 를 통해 설정하고 싶은 위젯을 선택하여 대시보드에 추가합니다.

지표(Metrics) 설정

- 1. CloudWatch 콘솔에서 왼쪽 메뉴의 **“Metrics”**를 선택합니다.

- 2. 모니터링하려는 서비스(예: EC2, RDS 등)를 선택합니다.

- 3. 지표를 선택하여 그래프에 추가합니다.

- 4. 선택한 지표를 대시보드에 추가할 수도 있습니다.

알람(Alarms) 설정

- 1. CloudWatch 콘솔에서 왼쪽 메뉴의 **“Alarms”**를 선택합니다.

- 2. **“Create alarm”**을 클릭합니다.

- 3. 모니터링할 지표를 선택하고 Next를 클릭합니다.

- 4. 조건을 설정합니다 (예: CPU 사용률이 80% 이상일 때 알람 발생).

- 5. 알람 발생 시 수행할 작업(SNS 주제에 알림 전송 등)을 설정합니다.

- 6. 알람 이름을 입력하고 **“Create alarm”**을 클릭합니다.

이메일 알림 추가

이메일 작성 후 [create topic] 으로 알림 정보 저장해주면 됩니다.

저장하고 나면 Amazon SNS 에 저장된 것을 볼 수 있습니다. 

CloudWatch Logs Insights 는 다음 포스팅에서 하겠습니다.

https://juntcom.tistory.com/253

스프링 시큐리티 및 JWT 를 활용하기 위해 결국 유저정보를 저장하는 DB 가 있어야 합니다.

아래 글과 겹치는 부분 있을 수 있으니 먼저 확인해보세요. 아래 포스트는 디비 없이 하드코딩으로 user 와 password 를 설정했습니다.
https://juntcom.tistory.com/249 

회원 테이블

CREATE TABLE users (
    id BIGINT AUTO_INCREMENT PRIMARY KEY,
    username VARCHAR(50) UNIQUE NOT NULL,
    password VARCHAR(100) NOT NULL,
    enabled BOOLEAN NOT NULL,
    authority VARCHAR(50) NOT NULL
);

user 테이블과

authority 권한 테이블을 정규화 해서 나눌 수도 있지만 한 유저당 여러권한이 없다고 보는게 낫고 예시를 위해 한 테이블로 진행하려고 합니다. 

Entity Class

@Setter
@Getter
@Entity
@Table(name = "users")
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(unique = true, nullable = false)
    private String username;

    @Column(nullable = false)
    private String password;

    @Column(nullable = false)
    private boolean enabled;

    @Column(nullable = false)
    private String authority;

}

CustomUserDetailsService 

UserDetailsService 를 implements 해야 합니다. 

@Service
public class CustomUserDetailsService implements UserDetailsService {

    @Autowired
    private UserRepository userRepository;

    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        User user = userRepository.findByUsername(username);
        if (user == null) {
            throw new UsernameNotFoundException("User not found");
        }

        return new org.springframework.security.core.userdetails.User(user.getUsername(), user.getPassword(),
                user.isEnabled(), true, true, true,
                Collections.singletonList(new SimpleGrantedAuthority(user.getAuthority())));
    }
}

UserRepository

package com.junt.studybasic.repository;

import com.junt.studybasic.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository<User, Long> {
    User findByUsername(String username);
}

Security 

package com.junt.studybasic.config;

import com.junt.studybasic.filter.JwtRequestFilter;
import com.junt.studybasic.service.CustomUserDetailsService;
import com.junt.studybasic.util.JwtUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.authentication.AuthenticationManager;
import org.springframework.security.config.annotation.authentication.configuration.AuthenticationConfiguration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.http.SessionCreationPolicy;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.security.web.SecurityFilterChain;
import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;

@Configuration
public class SecurityConfig {

    @Autowired
    private JwtRequestFilter jwtRequestFilter;

    @Autowired
    private CustomUserDetailsService customUserDetailsService;

    @Bean
    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
        http
            .csrf(csrf -> csrf.disable())
            .authorizeHttpRequests(authorizeRequests ->
                authorizeRequests
                    .requestMatchers("/api/auth/**").permitAll()
                    .anyRequest().authenticated()
            )
            .sessionManagement(sessionManagement ->
                sessionManagement.sessionCreationPolicy(SessionCreationPolicy.STATELESS)
            )
            .addFilterBefore(jwtRequestFilter, UsernamePasswordAuthenticationFilter.class);

        return http.build();
    }

    @Bean
    public AuthenticationManager authenticationManager(AuthenticationConfiguration authenticationConfiguration) throws Exception {
        return authenticationConfiguration.getAuthenticationManager();
    }

    @Bean
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }
}

Login Controller 

package com.junt.studybasic.controller;

import com.junt.studybasic.util.JwtUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.authentication.AuthenticationManager;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api/auth")
public class AuthController {

    @Autowired
    private AuthenticationManager authenticationManager;

    @Autowired
    private UserDetailsService userDetailsService;

    @Autowired
    private JwtUtil jwtUtil;

    @PostMapping("/login")
    public String createAuthenticationToken(@RequestBody AuthRequest authRequest) throws Exception {
        authenticationManager.authenticate(
                new UsernamePasswordAuthenticationToken(authRequest.getUsername(), authRequest.getPassword())
        );

        final UserDetails userDetails = userDetailsService.loadUserByUsername(authRequest.getUsername());
        final String jwt = jwtUtil.generateToken(userDetails);

        return jwt;
    }
}

class AuthRequest {
    private String username;
    private String password;

    // Getters and Setters
}

회원가입 API

UserService

package com.junt.studybasic.service;

import com.junt.studybasic.entity.User;
import com.junt.studybasic.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

    @Autowired
    private PasswordEncoder passwordEncoder;

    public User registerNewUser(String username, String password, String authority) {
        User user = new User();
        user.setUsername(username);
        user.setPassword(passwordEncoder.encode(password));
        user.setEnabled(true);
        user.setAuthority(authority);
        return userRepository.save(user);
    }
}

AuthController

package com.junt.studybasic.controller;

import com.junt.studybasic.entity.User;
import com.junt.studybasic.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api/auth")
public class AuthController {

    @Autowired
    private UserService userService;

    @PostMapping("/register")
    public User registerUser(@RequestBody RegisterRequest registerRequest) {
        return userService.registerNewUser(
                registerRequest.getUsername(),
                registerRequest.getPassword(),
                registerRequest.getAuthority()
        );
    }
}

@Getter
@Setter
class RegisterRequest {
    private String username;
    private String password;
    private String authority;

}

JwtUtil

@Component
public class JwtUtil {

    private final SecretKey SECRET_KEY = Keys.secretKeyFor(SignatureAlgorithm.HS256);

    public String extractUsername(String token) {
        return extractClaim(token, Claims::getSubject);
    }

    public Date extractExpiration(String token) {
        return extractClaim(token, Claims::getExpiration);
    }

    public <T> T extractClaim(String token, Function<Claims, T> claimsResolver) {
        final Claims claims = extractAllClaims(token);
        return claimsResolver.apply(claims);
    }

    private Claims extractAllClaims(String token) {
        return Jwts.parserBuilder()
                .setSigningKey(SECRET_KEY)
                .build()
                .parseClaimsJws(token)
                .getBody();
    }

    private Boolean isTokenExpired(String token) {
        return extractExpiration(token).before(new Date());
    }

    public String generateToken(UserDetails userDetails) {
        return createToken(userDetails.getUsername());
    }

    private String createToken(String subject) {
        return Jwts.builder()
                .setSubject(subject)
                .setIssuedAt(new Date(System.currentTimeMillis()))
                .setExpiration(new Date(System.currentTimeMillis() + 1000 * 60 * 60 * 10)) // 10시간 유효
                .signWith(SECRET_KEY)
                .compact();
    }

    public Boolean validateToken(String token, UserDetails userDetails) {
        final String username = extractUsername(token);
        return (username.equals(userDetails.getUsername()) && !isTokenExpired(token));
    }
}

JwtRequestFilter

@Component
public class JwtRequestFilter extends OncePerRequestFilter {

    @Autowired
    private UserDetailsService userDetailsService;

    @Autowired
    private JwtUtil jwtUtil;

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
            throws ServletException, IOException {

        final String authorizationHeader = request.getHeader("Authorization");

        String username = null;
        String jwt = null;

        if (authorizationHeader != null && authorizationHeader.startsWith("Bearer ")) {
            jwt = authorizationHeader.substring(7);
            username = jwtUtil.extractUsername(jwt);
        }

        if (username != null && SecurityContextHolder.getContext().getAuthentication() == null) {

            UserDetails userDetails = this.userDetailsService.loadUserByUsername(username);

            if (jwtUtil.validateToken(jwt, userDetails)) {

                UsernamePasswordAuthenticationToken usernamePasswordAuthenticationToken = new UsernamePasswordAuthenticationToken(
                        userDetails, null, userDetails.getAuthorities());
                usernamePasswordAuthenticationToken.setDetails(new WebAuthenticationDetailsSource().buildDetails(request));
                SecurityContextHolder.getContext().setAuthentication(usernamePasswordAuthenticationToken);
            }
        }
        chain.doFilter(request, response);
    }
}

참고

유저 권한에 따라 코드를 다르게 실행하는 방법

1. 메서드 수준의 보안 애노테이션 사용

Spring Security는 메서드 수준에서 접근 제어를 지원하는 몇 가지 애노테이션을 제공합니다. 가장 일반적인 애노테이션은 @PreAuthorize와 @Secured입니다.

1.1 @PreAuthorize 애노테이션 사용

@PreAuthorize 애노테이션을 사용하면 메서드 호출 전에 표현식을 평가하여 접근을 제어할 수 있습니다. 이를 위해 @EnableGlobalMethodSecurity(prePostEnabled = true)를 설정해야 합니다.

package com.junt.studybasic.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;

@Configuration
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class MethodSecurityConfig {
    // 추가 설정이 필요 없다면 이 클래스는 비어 있어도 됩니다.
}

서비스 클래스 예시

package com.junt.studybasic.service;

import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    @PreAuthorize("hasRole('ROLE_ADMIN')")
    public void adminOnlyMethod() {
        // 관리자 전용 메서드 로직
    }

    @PreAuthorize("hasAnyRole('ROLE_USER', 'ROLE_ADMIN')")
    public void userOrAdminMethod() {
        // 사용자 또는 관리자 접근 가능 메서드 로직
    }
}

2. Spring Security 권한 검사 API 사용

Spring Security의 권한 검사 API를 사용하여 프로그램 내에서 동적으로 권한을 검사할 수도 있습니다.

2.1 SecurityContextHolder를 사용한 권한 검사

@Service
public class MyService {

    public void performActionBasedOnRole() {
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();

        if (authentication.getAuthorities().contains(new SimpleGrantedAuthority("ROLE_ADMIN"))) {
            // 관리자 전용 로직
        } else if (authentication.getAuthorities().contains(new SimpleGrantedAuthority("ROLE_USER"))) {
            // 사용자 전용 로직
        } else {
            // 기타 권한 로직
        }
    }
}

3. 컨트롤러에서 권한에 따라 다른 로직 수행

Spring MVC 컨트롤러에서도 @PreAuthorize를 사용할 수 있습니다.

3.1 컨트롤러에서의 예시

package com.junt.studybasic.controller;

import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @GetMapping("/admin")
    @PreAuthorize("hasRole('ROLE_ADMIN')")
    public String adminEndpoint() {
        return "관리자 전용 페이지";
    }

    @GetMapping("/user")
    @PreAuthorize("hasRole('ROLE_USER')")
    public String userEndpoint() {
        return "사용자 전용 페이지";
    }

    @GetMapping("/common")
    @PreAuthorize("hasAnyRole('ROLE_USER', 'ROLE_ADMIN')")
    public String commonEndpoint() {
        return "모든 사용자 접근 가능 페이지";
    }
}

요약

• 메서드 수준 보안 애노테이션: @PreAuthorize와 @Secured를 사용하여 메서드 접근 제어.

• 권한 검사 API: SecurityContextHolder를 사용하여 동적으로 권한 검사.

• 컨트롤러에서 권한 검사: @PreAuthorize를 사용하여 요청 핸들러 접근 제어.

• 템플릿 엔진에서 권한 검사: Thymeleaf를 사용하여 동적으로 UI 요소 표시.

프링 부트에서 의존성 주입(DI, Dependency Injection)은 주로 세 가지 방식으로 이루어집니다: 생성자 주입, 수정자 주입, 필드 주입. 각각의 방법에 대한 코틀린 예시를 제공하겠습니다.

1. 생성자 주입(Constructor Injection)

생성자 주입은 가장 권장되는 방법으로, 클래스의 의존성을 생성자를 통해 주입하는 방식입니다.

예시: 생성자 주입

package com.example.demo.service

import org.springframework.stereotype.Service

@Service
class GreetingService {
    fun greet(name: String): String {
        return "Hello, $name!"
    }
}

package com.example.demo.controller

import com.example.demo.service.GreetingService
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RequestParam
import org.springframework.web.bind.annotation.RestController

@RestController
class GreetingController(private val greetingService: GreetingService) {

    @GetMapping("/greet")
    fun greet(@RequestParam name: String): String {
        return greetingService.greet(name)
    }
}

2. 수정자 주입(Setter Injection)

수정자 주입은 의존성을 수정자 메서드(Setter)를 통해 주입하는 방식입니다.

package com.example.demo.controller

import com.example.demo.service.GreetingService
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RequestParam
import org.springframework.web.bind.annotation.RestController

@RestController
class GreetingController {

    private lateinit var greetingService: GreetingService

    @Autowired
    fun setGreetingService(greetingService: GreetingService) {
        this.greetingService = greetingService
    }

    @GetMapping("/greet")
    fun greet(@RequestParam name: String): String {
        return greetingService.greet(name)
    }
}

여기서 GreetingController 클래스는 setGreetingService 메서드를 통해 GreetingService를 주입받습니다. 이 방법은 주입할 의존성이 선택적일 때 유용할 수 있습니다.

3. 필드 주입(Field Injection)

필드 주입은 의존성을 클래스의 필드에 직접 주입하는 방식입니다.

예시: 필드 주입

package com.example.demo.controller

import com.example.demo.service.GreetingService
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RequestParam
import org.springframework.web.bind.annotation.RestController

@RestController
class GreetingController {

    @Autowired
    private lateinit var greetingService: GreetingService

    @GetMapping("/greet")
    fun greet(@RequestParam name: String): String {
        return greetingService.greet(name)
    }
}

정리

• 생성자 주입: 가장 권장되는 방법으로, 변경 불가능하고 테스트가 용이합니다.

• 수정자 주입: 선택적 의존성을 주입할 때 유용합니다.

• 필드 주입: 간단하지만, 테스트와 유지보수가 어렵고 권장되지 않습니다.