프리코스: 진행 방식

🟡 과제 제출 전 체크 리스트

• 터미널에서 java -version을 실행하여 Java 버전이 21인지 확인한다. Eclipse 또는 IntelliJ IDEA와 같은 IDE에서 Java 21로 실행되는지 확인한다.
• 터미널에서 Mac 또는 Linux 사용자의 경우 ./gradlew clean test 명령을 실행하고, Windows 사용자의 경우 gradlew.bat clean test 또는 ./gradlew.bat clean test 명령을 실행할 때 모든 테스트가 아래와 같이 통과하는지 확인한다.
  

프리코스: 1주차 과제

과제 진행 요구 사항

• 미션은 문자열 덧셈 계산기 저장소를 포크하고 클론하는 것으로 시작
• 기능을 구현하기 전 README.md에 구현할 기능 목록을 정리해 추가
• Git의 커밋 단위는 앞 단계에서 README.md에 정리한 기능 목록 단위로 추가 → AngularJS Git Commit Message Conventions을 참고해 커밋 메시지를 작성한다.
• 자세한 과제 진행 방법은 프리코스 진행 가이드 문서를 참고

기능 요구 사항

• 쉼표(,) 또는 콜론(:)을 구분자로 가지는 문자열을 전달하는 경우 구분자를 기준으로 각 숫자의 합을 반환 ⇒ ex) "" => 0, "1,2" => 3, "1,2,3" => 6, "1,2:3" => 6

  // text가 공백일 경우 0 반환
  if (text == null) {}
  if (text.isEmpty()) {}
  // 구분자를 기준으로 문자열을 나누어 저장
  String[] numbers = text.split(",|;");

• 기본 구분자(쉼표, 콜론) 외에 커스텀 구분자를 지정 → 문자열 앞부분의 "//"와 "\n" 사이에 위치하는 문자를 커스텀 구분자로 사용

  if (text == null) {}
  if (text.isEmpty()) {}
  String[] numbers = text.split(",");

  출력 java.util.regex.Matcher[pattern=//(.)\n(.*) region=0,7 lastmatch=]

• 사용자가 잘못된 값을 입력할 경우 IllegalArgumentException을 발생시킨 후 애플리케이션은 종료

입출력 요구 사항 및 실행 결과 예시

입력

• 구분자와 양수로 구성된 문자

출력

• 덧셈 결과

  결과: 6

실행 결과 예시

덧셈할 문자열을 입력해 주세요.
1,2:3
결과: 6

프로그래밍 요구 사항

✏️ 배운점

커스텀 구분자

자바에서 정규 표현식 전문적으로 다루는 클래스인 java.util.regex 패키지를 사용, 패키지 안의 클래스중 주로 Pattern 클래스와 Matcher 클래스가 사용된다.

정규식 클래스의 장점은 정규식을 Pattern 객체로 미리 컴파일 해둘수 있어, 처리 속도 빠르고, 매칭된 데이터들을 좀더 상세히 다룰 수 있다.

Pattern pattern = Pattern.compile("//(.)\n(.*)");

String text = "//;\n1;2;3";
Matcher m = pattern.matcher(text);

IllegalArgumentException이란?

호출자가 인수로 부적절한 값을 넘길 때 던지는 예외로, 간단히 설명하면 사용자가 값을 잘못 입력한 경우에 발생하는 예외이다.

public void setMonth(int month) {
    if (month > 12) {
            throw new IllegalArgumentException("달은 12월까지 입니다.")
        }
    this.month = month;
}

IllegalStateException

대상 객체의 상태가 호출된 메서드를 수행하기에 적절하지 않을 때 발생시킬 수 있는 예외로, 간단히 설명하면 체스 게임을 진행하는데, 체스판이 생성되지 않은 경우 발생하는 예외이다.

public void start() {
    if(this.board == null) {
    thorow new IllegalStateException("보드판이 준비되지 않았습니다.")
}

NullPointerException

null 값을 허용하지 않는 메서드에 null을 건낼 때 발생시킬 수 있는 예외로, IllegalArgumentException를 발생시킬 수 있으나 관례상 null을 건낼 경우 NullPointerException 예외를 발생시킨다.

public void setMonth(int month) {
    if (month == null) {
        throw new NullPointerException("달은 1월부터 12월까지 입니다.")
    }    
    if (month > 12){
        throw new IllegalArgumentException("달은 12월까지 입니다.")
    }
    this.month = month;
}

소감문

한 주 동안 리팩토링 방법이나 TDD 등 프로젝트에 접목해보지 못한 것 들을 알 수 있는 소중한 시간들이었던 것 같다.

리팩토링 방법이나 TDD를 좀 더 응용해서 2주차를 진행하고, 공통 피드백을 받아 부족한 부분을 한 단계 더 보완해낼 예정이다.

정신없이 지나간 1주일이었지만 정말 소중한 시간이었으며, 예상보다 더 많은 것들을 배울 수 있어 좋았다. 특히나 부족하게 여겨졌던 기초를 한 번 더 다질 수 있었고, 사람들과 디스코드에서 대화하며 다양한 정보를 얻을 수 있어 좋았던 것 같다.

이를 토대로 2주차도 나아가볼 예정이다.

Test Driven Development의 약자로 선 테스트 후 개발 방식의 프로그래밍 방법이다. 과거 개발 방식 초기에는 Test First Development (테스트 우선 개발)로 불렸었다.

TDD의 개발주기

TDD의 개발 주기가 존재하는데 Red, Green, Yellow 단계로 나뉜다.

• Red 단계: 실패하는 테스트 코드를 먼저 작성 → 실패하는 테스트 코드를 작성할 때까지 실제 코드 미작성

  ✍ 예제 코드

  @Test
  public void testSum(){
     Calculator calculator = new Calculator();
     assertEquals(5, calculator.sum(2, 3));
  }

• Green 단계: 테스트 코드를 성공시키기 위한 실제 코드를 작성한다. → 실패하는 테스트를 통과할 정도의 최소한으로 실제 코드를 작성

  ✍ 예제 코드

  public class Calculator {
    public int add(int a, int b) {
        return a + b;
    }
  }

• Yellow 단계에서는 중복 코드 제거, 일반화 등의 리팩토링을 수행한다.

💭 일반적인 개발 방식

요구사항 분석 → 설계 → 개발 → 테스트 → 배포의 형태로 개발 주기를 갖는다.

일반적인 개발 방식의 단점은 아래와 같이 가지고 있다.

1. 소비자의 요구 사항이 처음부터 명확하지 않을 수 있음.
2. 처음부터 완벽한 설계가 어려움.
3. 자체적으로 버그 검출 능력 저하 혹은 소스코드의 품질이 저하될 수 있음.
4. 자체 테스트 비용이 증가할 수 있음.

❗ 재사용 및 관리가 어려워 유지 보수를 어렵게 만든다.

TDD의 장점

• TDD만의 반복적인 단계가 진행되며, 자연스럽게 코드의 버그가 줄고, 소스코드는 간결해진다.

• 명확한 요구사항을 기반으로 코드를 작성 : 테스트가 곧 코드의 명세서 역할을 할 수 있다. : 테스트는 유연성, 유지보수성, 재사용성을 제공

• 추가 구현의 용이함 : 자동화된 유닛 테스팅을 전제하므로 테스트 기간을 획기적으로 단축

TDD의 단점

• 생산성의 저하 : 처음부터 2개의 코드를 짜야하고, 중간중간 테스트를 하며 고쳐나가야 하기 때문

• 테스트 관리의 복잡성 : 프로젝트가 커질수록 테스트 코드도 많아지기에 유지 보수하는데에도 추가적인 노력 필요

TDD의 대표적인 Tool - JUnit

자바의 단위 테스팅 프레임 워크로, JUnit만 존재하는 것은 아니다. 다른 언어들도 프레임워크가 존재하며 , 보통 이름을 xUnit이라 지칭한다.

일정 주기 마다 실행

✍ 코드

pip install django-apscheduler

스케쥴러를 사용하기 위해 우선 라이브러리를 받아준다. 이후 settings.py에 세팅 해준다.

✍ 코드

# settings.py
INSTALLED_APPS = [
    'django_apscheduler',
]

✍ 코드

# views.py

from datetime import datetime
from apscheduler.schedulers.background import BackgroundScheduler

def Scheduler():
    Now = datetime.now()
    print("실행 후 5초가 지났습니다. 현재 시각 :", Now.time())

# 스케줄러 설정
scheduler = BackgroundScheduler()
scheduler.add_job(Scheduler, 'interval', seconds = 5)
# 스케줄러 시작
scheduler.start()

필요한 라이브러리들을 import해준다. datetime은 시각을 확인해주기 위해 import해주었다.

💻 출력

실행 후 5초가 지났습니다. 현재 시각 : 14:32:29.601103
실행 후 5초가 지났습니다. 현재 시각 : 14:32:34.593561
실행 후 5초가 지났습니다. 현재 시각 : 14:32:39.599084
실행 후 5초가 지났습니다. 현재 시각 : 14:32:44.597033
실행 후 5초가 지났습니다. 현재 시각 : 14:32:49.590092

📢 터미널 실행창

이와 같이 실행되는 것을 확인해 볼 수 있다.

Simple JWT는 Django REST Framework에 대한 JSON 웹 토큰 인증 백엔드를 제공한다.

사용하는 라이브러리는 아래와 같다.

✍ 코드

pip install djangorestframework-simplejwt

📚 simple_jwt 세팅

✍ 코드

# settings.py

from datetime import timedelta

INSTALLED_APPS = [
    …
    # simple-jwt 추가해주기 
    'rest_framework_simplejwt',
]

SIMPLE_JWT = {
    'ACCESS_TOKEN_LIFETIME': timedelta(minutes=60),
    'REFRESH_TOKEN_LIFETIME': timedelta(days=1),
    'ROTATE_REFRESH_TOKENS': True,
}

simple_jwt기본 설정을 해준다. Access ToKen과 Refresh Token의 생명주기를 60분으로 설정한다. Rotate Token 회전시킬지 여부를 지정하는데, 보안상 권장하는 편이다.

📚 로그인

✍ 코드

# views.py

from django.contrib.auth.hashers import check_password
from rest_framework_simplejwt.tokens import RefreshToken

@api_view(['POST'])
def user_login(request):
    if request.method == 'POST':
        username = request.data.get('username')
        password = request.data.get('password')

        user = AuthUser.objects.filter(username=username).first()
        if user and check_password(password, user.password):
            # 인증 성공시 바로 로그인
            login(request, user)
            refresh = RefreshToken.for_user(user)
            access_token = str(refresh.access_token)
            refresh_token = str(refresh)

            # Users에서 nickname 가져오기
            try:
                user_info = UserProfile.objects.get(username=user.username)
                nickname = user_info.nickname
            except UserProfile.DoesNotExist:
                nickname = None

            return Response(
                {
                    'status': 'success',
                    'username': user.username,
                    'nickname': nickname,
                    'access_token': access_token,
                    'refresh_token': refresh_token,
                    'message': '로그인이 완료되었습니다.'
                },
                status=status.HTTP_200_OK
            )
        else:
            # 인증 실패
            logger = logging.getLogger(__name__)
            logger.error(f'Failed login attempt for username: {username}')
            return Response(
                {
                    'status': 'fail',
                    'message': '로그인에 실패했습니다.'
                },
                status=status.HTTP_401_UNAUTHORIZED
            )

check_password는 두 password를 비교하여 boolean값을 리턴한다. 이후 패스워드 및 username이 일치할 경우 자동으로 로그인이 되며, access토큰과 refresh토큰을 발급해준다.

• Access Token : 로그인시 발급되며, 사용자 인증 정보를 담고 있음

• Refresh Token : Access토큰을 재발급 받는 용도로 유효기간이 더 길다.

우선 SMS 인증을 위해 Naver Cloud Platform에 가입을 해야한다.

물론 Naver 말고도 SMS 인증을 도와주는 다른 플랫폼도 많다. 하지만 해당 플랫폼을 선택한 이유는 10만 크레딧을 무료로 제공해주기 때문이다.

회원가입을 완료했으면 Simple & Easy Notification Service를 이용신청하면 된다. 이후에 프로젝트를 생성해준다. 각 서비스 타입 및 이름은 각자 작성해준다.

생성 후 발신번호를 꼭 등록해주어야 하는데, 본인 소유의 발신번호일 경우 간단하게 신청이 된다.

여기까지 기본 설정이 끝났으면 인증키를 발급받아야한다.

📚 API 인증키 및 기타 인증키

• OPEN API Key project 생성시 발급 가능하다. (

• Access Key / Secret Key 마이페이지 - 인증키 관리에서 발급 받을 수 있다.
  
  

📚 SMS 인증

✍ 코드

create table sms(
    id int auto_increment primary key,
    phone_number varchar(15),
    auth_number varchar(6)
);

# models.py

class Sms(models.Model):
    phone_number = models.CharField(max_length=15, blank=True, null=True)
    auth_number = models.CharField(max_length=6, blank=True, null=True)

    class Meta:
        managed = False
        db_table = 'sms'

    @classmethod
    def create_sms(cls, phone_number, auth_number):
        sms = cls(phone_number=phone_number, auth_number=auth_number)
        sms.save()

우선 위와 같이 테이블을 만들어준다. 테이블 생성 및 수정, 삭제시 반드시 해줘야하는 'python manage.py migrate'를 해준다.

저장 메서드를 추가하여 SMS를 저장할 때 사용한다.

✍ 코드

pip install requests

필요한 라이브러리인 requests를 설치해준다.

✍ 코드

# sms.py

import json
import requests
import time
import base64
import hashlib
import hmac

def make_signature(url, access_key, secret_key):
    timestamp = str(int(time.time() * 1000))
    method = "POST"
    message = method + " " + url + "\n" + timestamp + "\n" + access_key
    message = bytes(message, 'UTF-8')
    secret_key = bytes(secret_key, 'UTF-8')
    signingkey = base64.b64encode(hmac.new(secret_key, message, digestmod=hashlib.sha256).digest())
    return signingkey

def send_sms(phone_number, content):
    user_access_key = "access key 입력"
    user_secret_key = "secret key 입력"
    sms_service_id = "OPEN API Key(서비스 ID)"
    url = "/sms/v2/services/" + sms_service_id + "/messages"
    api_url = 'https://sens.apigw.ntruss.com' + url

    headers = {
        'Content-Type': 'application/json; charset=utf-8',
        'x-ncp-apigw-timestamp': str(int(time.time() * 1000)),
        'x-ncp-iam-access-key': user_access_key,
        'x-ncp-apigw-signature-v2': make_signature(url, user_access_key, user_secret_key)
    }

    body = {
        "type": "SMS",
        "contentType": "COMM",
        "countryCode": "82",
        "from": "등록한 연락처",
        "content": content,
        "messages": [
            {
                "to": phone_number,
            }
        ]
    }

    body_result = json.dumps(body)

    response = requests.post(api_url, headers=headers, data=body_result)
    response.raise_for_status()
    response_result = response.json()

    send_result = response_result.get('statusCode')

    if send_result == "202":
        return True
    else:
        return False

• 기본정보

• 메시지 발송

위 표를 참고하여 sms.py코드를 작성하였다. 자세한건 SMS API사이트에서 확인할 수 있다.

✍ 코드

# views.py
import random
from .sms import send_sms

@api_view(['POST'])
def SMS(request):
    if request.method == 'POST':
        phone_number = request.data.get('phone_number')
        auth_number = str(random.randint(100000, 999999))
        sms_content = f"[TEST]\n인증 코드는 {auth_number} 입니다."
        send_result = send_sms(phone_number, sms_content)

        if send_result:
            # SMS를 데이터베이스에 저장
            Sms.create_sms(phone_number, auth_number)
            return Response({'message': '인증 문자 전송이 완료되었습니다.'}, status=status.HTTP_201_CREATED)
        else:
            return Response({'message': '인증 문자 전송에 실패했습니다.'}, status=status.HTTP_500_INTERNAL_SERVER_ERROR)

Sms.create_sms(phone_number, auth_number)위에서 만든 메소드를 사용하여 저장한다.

이후 데이터를 전송하면 아래와 같이 인증 코드가 온 것을 확인해 볼 수 있다.

장고에서는 DB 연동시 자동으로 회원가입에 사용할 수 있는 Auth_User테이블이 생성된다.

models.py에 AuthUser를 가져온 후 사용하기 위해 간단히 설정을 해줘야한다.

✍ 코드

# models.py
class AuthUser(models.Model):
    password = models.CharField(max_length=128)
    last_login = models.DateTimeField(blank=True, null=True)
    is_superuser = models.IntegerField(default=False) # default 설정
    username = models.CharField(unique=True, max_length=150)
    first_name = models.CharField(max_length=150)
    last_name = models.CharField(max_length=150)
    email = models.CharField(max_length=254)
    is_staff = models.IntegerField(default=0) # default 설정
    is_active = models.IntegerField(default=0) # default 설정
    date_joined = models.DateTimeField(auto_now_add = True) # 날짜 자동 입력

    class Meta:
        managed = False
        db_table = 'auth_user'

바로 기본값(default) 설정이다. 기본값을 설정하지 않을 경우 Null값이 허용되지 않은 열들이 있어 에러가 발생한다. is_superuser, is_staff, is_active 값을 default로 0 혹은 False로 설정한다. 이후 date_joined는 auto_now_add를 True로 주어 데이터 입력시 값이 자동으로 입력되게 해준다.

✍ 코드

# serializers.py

class AuthUserSerializer(serializers.ModelSerializer):
    class Meta:
        model = AuthUser
        fields = ('id', 'username', 'password')

# views.py
@api_view(['POST'])
def signup(request):
    if request.method == 'POST':
        serializer = AuthUserSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()

            return Response({'message': '회원 가입이 완료되었습니다.'}, status=status.HTTP_201_CREATED)
        else:
            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

간단히 POST를 받아와 회원가입을 할 수 있다. 이후 JSON형식으로 username과 password를 설정한다.

✍ 코드

{
    "username":"username",
    "password":"password"
}

MySQL에서 DB를 확인해보면 아래와 같이 입력되어 있는 것을 볼 수 있다. 하지만 보안을 위해 password는 암호화하여 DB에 저장할 수 있도록 해주는 것이 좋다.

📚 PASSWORD 암호화

make_password : Django에서 제공하는 함수로 문자열을 암호화 시킨다.

✍ 코드

# models.py

from django.contrib.auth.hashers import make_password

@api_view(['POST'])
def signup(request):
    if request.method == 'POST':
        serializer = AuthUserSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
             # Serializer에서 입력받은 원시 비밀번호를 가져온다.
            raw_password = serializer.validated_data.get('password')

            # make_password 함수를 사용하여 비밀번호를 해시화하고 저장한다.
            hashed_password = make_password(raw_password)
            serializer.save(password=hashed_password)

            return Response({'message': '회원 가입이 완료되었습니다.'}, status=status.HTTP_201_CREATED)
        else:
            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

위와 같이 코드를 수정 후 저장하면 비밀번호가 암호화 되어 들어간 것을 확인할 수 있다.

URL의 쿼리 매개변수에 대한 접근을 제공한다.

📚 query_params

전통적인 Django는 request.GET을 사용하여 쿼리 매개변수에 접근한다. 하지만 DRF에서는 request.query_params를 권장한다.

이를 통해 내가 원하는 데이터만 검색을 할 수 있다. 우선 코드를 작성하기 이전 어떤 데이터가 있는지 확인을 해야한다.

📢 Postman 실행창

기존 테이블에 임의로 데이터를 추가하였다.

✍ 코드

@api_view(['GET', 'POST', 'PUT', 'DELETE'])
def TestAPI(request, id=None):
    queryset = Testapi.objects.all()
    if request.method == 'GET':
        title = request.query_params.get('title')
        if title:
            queryset = queryset.filter(title__contains=title)
        serializer = TestAPISerializer(queryset, many=True)
        return Response(serializer.data)

✍ status 상태 코드

URL입력시 ?title=안녕이라고 입력 후 조회시 title에 '안녕'이라는 글자가 들어가는 모든 데이터를 조회할 수 있다.

데이터 입력시 POST를 사용한다.

✍ 코드

# api/views.py
from rest_framework import status

@api_view(['POST'])
def postTestAPI(request):
    serializer = TestAPISerializer(data=request.data)
    if serializer.is_valid():
        serializer.save()
        return Response(serializer.data, status=status.HTTP_201_CREATED)
    return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)


# api/urls.py

from django.urls import path
from . import views

urlpatterns = [
    path('getapi/', views.getTestAPI),
    path('postapi/', views.postTestAPI) # 추가
]

✍ status 상태 코드

코드를 저장 후 서버를 실행해 준다. 주소창에 localhost:8000/api/postapi/를 입력하면 아래와 같은 창이 뜨게 된다.

📢 Chrome 실행창

✍ 코드

{
    "title": "POST API",
    "content": "post 되었습니다."
}

JSON형식의 데이터를 입력 후 POST버튼을 눌러준다.

📢 Postman 실행창

Postman같은 경우 왼쪽 GET을 POST로 변경 후 raw-JSON에 입력해야한다. 입력 후 send버튼을 누를 경우 위 이미지와 같이 보여진다.

다시 GET으로 확인해볼경우 정상적으로 데이터가 들어간 것을 확인할 수 있다.

📚 PUT

데이터 수정시 PUT을 사용한다.

✍ 코드

# api/views.py

@api_view(['PUT'])
def putTestAPI(request, id):
    try:
        data = Testapi.objects.get(id=id)
    except Testapi.DoesNotExist:
        return Response({'message': '해당 ID를 가진 데이터를 찾을 수 없습니다.'}, status=status.HTTP_404_NOT_FOUND)

    serializer = TestAPISerializer(data, data=request.data)

    if serializer.is_valid():
        serializer.save()
        return Response(serializer.data)

    return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)


# api/urls.py

urlpatterns = [
    path('getapi/', views.getTestAPI),
    path('postapi/', views.postTestAPI),
    path('putapi/', views.putTestAPI), # 추가
    path('putapi/<int:id>/', views.putTestAPI), # 추가
]

코드를 저장 후 서버를 실행해 준다. 주소창에 localhost:8000/api/putapi/1/를 입력 후 수정할 내용을 작성해준다.

📢 Postman 실행창

Postman같은 경우 왼쪽 GET을 PUT으로 변경 후 raw-JSON에 입력해야한다. 입력 후 send버튼을 누를 경우 위 이미지와 같이 보여진다.

📚 DELETE

데이터 삭제시 DELETE를 사용한다.

✍ 코드

# api/views.py

@api_view(['DELETE'])
def deleteTestAPI(request, id):
    try:
        Testapi_instance = Testapi.objects.get(id=id)
    except Testapi.DoesNotExist:
        return Response({'message': '해당 ID를 가진 데이터를 찾을 수 없습니다.'}, status=status.HTTP_404_NOT_FOUND)
    Testapi_instance.delete()
    return Response(status=status.HTTP_204_NO_CONTENT)


# api/urls.py

urlpatterns = [
    path('getapi/', views.getTestAPI),
    path('postapi/', views.postTestAPI),
    path('putapi/<int:id>/', views.putTestAPI),
    path('deleteapi/<int:id>/', views.deleteTestAPI), # 추가
]

코드를 저장 후 서버를 실행해 준다. 주소창에 localhost:8000/api/deleteapi/2/를 입력 후 send버튼을 누른다.

📢 Postman 실행창

Postman같은 경우 왼쪽 GET을 DELETE 변경 후 **send버튼을 누를 경우 삭제된다. 이후 다시 확인하면 id 2가 사라진 것을 볼 수 있다.

📚 URL하나로 GET, POST, PUT, DELETE하기

하나의 url로 GET, POST, PUT, DELETE를 처리할 수 있다.

✍ 코드

# app/views.py
@api_view(['GET', 'POST', 'PUT', 'DELETE'])
def TestAPI(request, id=None):
    if request.method == 'GET':
        data = Testapi.objects.all()
        serializer = TestAPISerializer(data, many=True)
        return Response(serializer.data)

    elif request.method == 'POST':
        serializer = TestAPISerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    elif request.method == 'PUT':
        try:
            data = Testapi.objects.get(id=id)
        except Testapi.DoesNotExist:
            return Response({'message': '해당 ID를 가진 데이터를 찾을 수 없습니다.'}, status=status.HTTP_404_NOT_FOUND)

        serializer = TestAPISerializer(data, data=request.data)

        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)

        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    elif request.method == 'DELETE':
        try:
            Testapi_instance = Testapi.objects.get(id=id)
        except Testapi.DoesNotExist:
            return Response({'message': '해당 ID를 가진 데이터를 찾을 수 없습니다.'}, status=status.HTTP_404_NOT_FOUND)
        Testapi_instance.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

# app/views.py
from django.urls import path
from . import views

urlpatterns = [
    path('testapi/', views.TestAPI),
    path('testapi/<int:id>/', views.TestAPI),
]

데코레이터에 GET, POST, PUT, DELETE를 넣고 elif문으로 어떤 요청인지 받아와 해당 코드를 실행할 수 있다.

📢 Chrome 실행창

📢 Postman 실행창

POST

PUT

DELETE 및 GET

Django 안에서 RESTful API 서버를 쉽게 만들게 도와주는 라이브러리다.

📚 필요 라이브러리

✍ 코드

$ pip install djangorestframework

Django REST Framework는 API를 구축할 수 있게 만들어 주기 때문에 꼭 필요하다.

📚 settings.py 설정

✍ 코드

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

    'api', # 생성한 앱 이름
    'rest_framework',
]

INSTALLED_APPS에 생성한 앱을 등록해야 사용할 수 있다.

📚 serializers.py 생성

✍ 코드

# api/serializers.py

from rest_framework.serializers import ModelSerializer
from .models import Testapi

class TestDataSerializer(ModelSerializer):
    class Meta:
        model = Testapi        # 테이블 명
        fields = '__all__'    # 사용할 필드(열)

serializer는 직렬화를 의미한다. django에 저장되어 있는 모델 인스턴스를 REST API에서 사용하는 JSON형태로 바꿔주는 역할을 한다.

📚 views.py 수정

✍ 코드

# api/views.py

#  HTTP 응답을 생성하고 반환
from rest_framework.response import Response
# 해당 함수가 특정 HTTP 요청 메서드를 처리
from rest_framework.decorators import api_view
from .models import Testapi
from .serializers import TestAPISerializer

@api_view(['GET'])
def getTestAPI(request):
    data = Testapi.objects.all()
    serializer = TestAPISerializer(data, many=True)
    return Response(serializer.data)

📚 urls.py 수정 및 생성

✍ 코드

# project/urls.py

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('api.urls'))
]

include를 사용하여 Django 애플리케이션을 모듈화하고 다른 애플리케이션에서 정의된 URL 패턴을 현재 애플리케이션에 재사용할 수 있다. 이를 통해 url을 별로 관리할 수 있도록 도와준다.

✍ 코드

# api/urls.py

from django.urls import path
from . import views

urlpatterns = [
    path('getapi/', views.getTestAPI)
]

'testapi/' 경로로 들어오는 요청은 'views.getTestAPI' 함수를 호출한다.

📚 실행

이제 서버를 실행시킨 후 주소창에 localhost:8000/api/testapi/를 입력하면 실행되는 창을 볼 수 있다.

📢 Chrome 실행창

📢 Postman 실행창

✍ 코드

$ python manage.py inspectdb > models.py

• python manage.py inspectdb > models.py : 기존에 연동되어 있는 DB 테이블을 models.py로 생성 및 저장해준다.

✍ 코드

$ python manage.py migrate
$ python manage.py runserver

DB를 수정 혹은 생성할 때 마다 migrate를 입력해줘야한다.

📚 필요한 테이블만 가져오기

inspectdb로 가져온 models.py를 사용하기 위해선 app폴더에 있는 models.py로 가져와야한다.

현재는 testapi만 필요하니 testapi만 옮겨줄 예정이다.

이후 필요없는 models.py는 지워는게 좋다.

물론 대부분의 테이블이 필요하다면 파일자체를 덮어쓰기해도 된다.

📚 에러발생

🔨 에러 코드

ValueError: source code string cannot contain null bytes

간혹 모델을 생성한 후 위와 같이 에러가 발생하는 것을 볼 수 있다.

굉장히 간단히 해결할 수 있는 문제이다. 생성된 모델이 다음과 같이 UTF-8로 Encoding되지 않아 발생하는 문제이다. vscode에서 인코딩부분을 누른 후 Save with Encoding으로 들어가 UTF-8로 변경해주면 쉽게 해결될 문제이다.

✍ 코드

create database test;
use test;

create table testapi(
    id int auto_increment primary key,
    title varchar(100),
    content longtext
);

  INSERT INTO testapi(title, content) 
  VALUES('안녕!', 'testapi야!');

select * from testapi;

MySQL에 연동하기 이전에 테이블에 생성 후 확인을 해준다. (물론 연동한 후 해도 상관은 없지만 미리 생성해두었다.)

📚 필요 라이브러리

✍ 코드

$ pip install mysqlclient

Python에서 MySQL서버와 통신을 할 수 있게 해주는 커넥터같은 역할을 해준다.

📚 settings.py 설정

✍ 코드

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'test', # 사용할 DataBase 이름
        'USER': 'root', # DB 사용자명
        'PASSWORD': '1234', # DB 사용자 암호
        'HOST': 'localhost',
        'PORT': '3306',
    }
}

위와 같이 Database의 정보를 입력한 후 저장한다. 서버를 실행하는 명령어를 사용하여 제대로 연결되었는지 확인할 수 있다.

서버 실행 명령어

✍ 코드

python manage.py runserver

📚 데이터베이스 테이블 연동

✍ 코드

python manage.py makemigrations
python manage.py migrate

• python manage.py makemigrations : 모델(models.py)의 변경 내역을 스키마에 적용시키는 방법
• python manage.py migrate : 실제 DB에 변경사항을 적용하는 명령어

정상적으로 적용 후 MySQL을 확인해보면 장고와 관련된 테이블들이 추가된 것을 확인해 볼 수 있다.

데이터의 집합(저장소)

📚 생성, 선택, 삭제

✍ 코드

CREATE DATABASE database_name;
USE database_name;
DROP DATABASE database_name;

📝 테이블(Table)

📚 생성 및 기본키(PK)

✍ 코드

CREATE TABLE table_name (
    column1 datatype primary key,
    column2 datatype,
    ...
);

컬럼에 따른 데이터 타입을 지정한다. 이때 Primary Key는 기본키로 중복 및 NULL값을 비허용한다. 보통 primary key는 id로 많이 지정한다.

✍ 코드

CREATE TABLE user (
    user_id int auto_increment primary key,
    name varchar(10)
);

위와 같이 입력을 할 경우 id에 자동으로 +1씩 하여 입력이 된다. name과 같은 경우 최대 10글자까지 입력할 수 있으며 NULL값이 허용된다.

📚 외래키(FK)

✍ 코드

CREATE TABLE info (
    info_id int auto_increment primary key,
    user_id int,
    phone_number varchar(11)
    FOREIGN KEY (user_id) REFERENCES user(user_id)
);

외래키(Foreign key)는 한 테이블의 열(또는 여러 열)이 다른 테이블의 기본 키나 후보 키에 대한 참조(링크)를 나타내는 열이나 열의 집합

외래 키 설정을 통해 데이터 무결성을 유지하고 관련 테이블 간의 관계를 명확하게 정의할 수 있다.

📚 열 추가(ADD COLUMN)

✍ 코드

ALTER TABLE table_name
ADD column_name data_type;

기존 테이블에 새로운 열을 추가한다.

📚 열 수정(MODIFY COLUMN)

✍ 코드

ALTER TABLE table_name
MODIFY column_name new_data_type;

기존 열의 데이터 타입을 변경한다.

📚 열 삭제(DROP COLUMN)

✍ 코드

ALTER TABLE table_name
DROP column_name;

테이블에서 기존 열을 삭제한다.

📚 외래 키 추가 (ADD FOREIGN KEY)

✍ 코드

ALTER TABLE child_table
ADD CONSTRAINT fk_name
FOREIGN KEY (child_column)
REFERENCES parent_table (parent_column);

외래 키를 추가하여 테이블 간의 관계를 정의한다.

📚 테이블 이름 변경 (RENAME TABLE)

✍ 코드

ALTER TABLE old_table_name
RENAME TO new_table_name;

기존 테이블의 이름을 변경한다.

📚 기본 키 추가 (ADD PRIMARY KEY)

✍ 코드

ALTER TABLE table_name
ADD PRIMARY KEY (column_name);

테이블에 새로운 기본 키를 추가한다.

📝 데이터

📚 조회(SELECT)

✍ 코드

SELECT * FROM table_name;

해당 테이블의 모든 데이터를 조회

✍ 코드

SELECT column1, column2 FROM table_name;

해당 테이블의 특정 열을 선택해서 조회

✍ 코드

SELECT * FROM table_name WHERE condition;

조건에 따라 데이터를 선택해서 조회

📚 추가, 입력(INSERT)

INSERT INTO table_name (column1, column2, ...) VALUES (value1, value2, ...);

테이블 중 입력할 열(column)에 값을 넣는다.

📚 업데이트(UPDATE)

UPDATE table_name SET column1 = value1, column2 = value2 WHERE condition;

조건(condition)에 맞는 열(column)에 값을 수정한다.

📚 삭제(DELETE)

DELETE FROM table_name WHERE condition;

조건(condition)에 맞는 열(column)을 삭제한다.

하나의 웹 사이트로 프로젝트 안에는 여러 개의 앱이 존재한다.

📚 프로젝트 생성하기

✍ 코드

django-admin startproject '프로젝트명' .

프로젝트명 다음에 오는 점 '.'은 현재 디렉터리를 의미한다. 즉, 현재 디렉터리를 기준으로 프로젝트를 생성한다. 기본적으로 project파일과 manage.py가 생긴 것을 확인해 볼 수 있다.

📚 프로젝트 구조

위 이미지에 있는 프로젝트 구조를 한 눈에 보기 쉽게 나타내어 봤다.

Django/
├─ manage.py
└─ project/
    ├─ __init__.py
    ├─ asgi.py
    ├─ settings.py
    ├─ urls.py
    └─ wsgi.py

📚 앱 생성하기

✍ 코드

django-admin startapp '앱 명' .

프로젝트 단독으로는 아무런 것도 만들 수 없다. 프로젝트에 기능을 추가하기 위해 앱을 생성해야한다. 기본적으로 api파일이 생긴 것을 확인해 볼 수 있다.

📚 프로젝트 구조

위 이미지에 있는 앱 구조를 한 눈에 보기 쉽게 나타내어 봤다.

Django/
├─ project/
├─ db.sqlite3
├─ manage.py
└─ api/
    ├─ __init__.py
    ├─ admin.py
    ├─ apps.py
    ├─ models.py
    ├─ tests.py
    ├─ views.py
    └─ migrations/

📚 로컬 서버 구동

기본적인 프로젝트와 앱을 생성하였으면 아래 코드를 통해 서버를 실행할 수 있다.

✍ 코드

python manage.py runserver

독립된 공간을 만들어주는 기능

다양한 프로젝트를 진행하며, 서로 다른 버전의 장고나 패키지들을 사용해야 하는 문제들이 발생할 수 있다.

이러한 문제를 해결하기 위해 가상 환경을 사용하는데, 하나의 PC안에 독립된 공간을 여러개 만들어 사용할 수 있다.

📚 가상 환경 구축 방법

✍ 코드

C:\> mkdir venv
C:\> cd venv
C:\venv\> python -m venv project

• python -m : 라이브러리 모듈을 스크립트로 실행

venv파일에 'project'라는 이름의 가상 환경을 생성했다면 이제 사용하기 위해 가상 환경에 진입해야한다.

가상 환경에 진입하기 위해 생성한 가상 환경에 있는 Scripts디렉터리의 activate 명령을 실행해야 한다.

✍ 코드

C:\venv\> cd C:\venv\project\Scripts
C:\venv\project\Scripts> activate

이렇게 실행을 하면 C:\ 왼쪽에 (project)가 생긴 것을 확인할 수 있다.

만약 activate로 실행이 안될 경우 .\activate로 실행할 수도 있다.

현재 가상 환경에서 벗어나고 싶을 경우 deactivate명령어를 실행하면 된다.

📚 맥(mac)에서 가상 환경 진입

mac은 가상 환경 진입하는 방법이 window와 다르다. 가상 환경을 생성하는 명령어 까진 같다.

✍ 코드

maehyong@mymac venvs % cd project/bin
maehyong@mymac bin % source activate
(project) maehyong@mymac bin %

window는 Scripts폴더가 생성되며, Linux나 Mac과 같은 경우 bin폴더가 생성된다.

📚 장고 설치

장고를 설치하기 이전 가상 환경에 들어가 있는지 꼭 확인 후 설치하는 것이 좋다.

그 이유는 위에서 설명 하였으니 위를 참고하면 될 것 같다.

✍ 코드

(project) C:\venv\project\Scripts> pip install django

• pip : 파이썬 라이브러리를 설치 및 관리

장고를 설치해줄 때 django==버전을 입력할 경우 해당 버전이 설치가 된다. 위와 같은 화면이 나올 경우 장고가 제대로 설치된 것이다.

Python기반의 풀스택 웹 프레임워크 오픈 소스로 웹을 만드는데 필요한 대부분의 기능을 가지고 있다.

여기서 웹 프레임워크를 간단히 설명하면 "웹 프로그램을 만들기 위한 스타터 키트"라고 생각하면 쉽다.

📚 Django의 장점

• 빠르다. 웹 개발시 번거로움을 배부분 처리해주어, 개발자가 애플리케이션의 개념부터 완성까지 단 시간 안에 진행할 수 있습니다.
  

• 보안성이 좋다. 보안을 중요하게 생각하여 개발을 하며 쉽게 발생할 수 있는 실수들을 막아줍니다.
  
• 확장성이 뛰어나다. 가장 많은 트래픽 수요를 충족시키기 위해 빠르고 유연하게 확장할 수 있습니다.

크게 3가지의 장점을 가지고 있는 장고는 Django 공식 사이트에 들어가 보면 위쪽 상단에 'The web framework for perfectionists with deadlines.'라고 적혀 있는 것을 확인해 볼 수 있다. 해석 해보면 '마감에 쫓기는 완벽주의자를 위한 웹 프레임워크'이다.

Django는 개발에 있어 정말 필요한 기능이 모여있다는 것을 알 수 있다.

📚 Django를 사용 중인 곳

• instargram

• toss
• 번개장터
• 화해
• 기타 등등..

대표적인 4곳을 가져와봤는데, 이외에도 많은 곳에서 Django를 사용하여 웹사이트를 구축했다.

그중 instargram에서는 세계에서 제일 큰 규모의 장고 웹사이트이며, toss는 사내 서비스 개발에 사용되었다.

📝 상속

부모 class의 내용을 자식 class가 물려받는 것

항목 순서는 의미가 없으며, 키는 중복될 수 없다. 또한, 키는 수정될 수 없지만, 값은 수정될 수 있다.

✍ 코드

class 부모:
    ...내용...

class 자식(부모):
    ...내용...

✍ 코드

class Country:
    name = '국가명'
    population = '인구'
    capital = '수도'

    def show(self):
        print('국가 클래스의 메소드입니다.')

class Korea(Country):
    def __init__(self, name):
        print('__init__')
        self.name = name

    def show_name(self):
        print('국가 이름은 : ', self.name)

위 코드를 실행시 Korea는 Country Class를 상속받게 된다.

✍ 코드

a = Korea('대한민국')
a.show()
a.show_name()
a.capital
a.name

💻 출력

__init__
국가 클래스의 메소드입니다.
국가 이름은 :  대한민국
수도
대한민국

• a = Korea('대한민국') 객체가 생성되며 name은 대한민국으로 변환된다.
• a.show(), a.capital, a.name Country를 상속 받았기 때문에 각각의 함수 및 변수가 실행되어 출력된다.
  
  

📝 추상 메소드

아직 구현이 종료되지 않은 미완성 메소드

추상 클래스를 지원하는 모듈 abc(Abstract Base Class)를 가져오기 위해 import를 해야한다.

• 정의되는 클래스의 괄호 안에 metaclass = abc.ABCMeta를 지정
• 추상 메소드 머리 위에 데코레이터 @abc.abstractmethod를 넣어 메소드가 추상이라는 것을 지정

  ✍ 코드

  from abc import *
  class Polygon(metaclass = MBCMeta):
    @abstractmethod
    def area(self):
        pass

  
  
  

📝 추상 클래스(abstract class)

미완성인 추상 메소드를 적어도 하나 이상 갖는 클래스로 부모인 추상 클래스는 자신만을 객체 인스턴스로 생성 불가능

이때 추상 메소드는 자식 클래스에서 반드시 구현해야한다.

항목의 순서나 내용을 수정할 수 있는 항목의 나열

[] : 콜론으로 구분된 항목을 표현합니다.

✍ 코드

A = []

비어있는 리스트를 생성하는 방법입니다.

📝 튜플(Tuple)

항목의 순서나 내용을 수정할 수 없는 항목의 나열

() : 콤마로 구분된 항목을 표현합니다.

기타 내용

✍ 코드

A = ()

비어있는 튜플을 생성하는 방법입니다.

📝 딕셔너리(Dict)

키와 값의 쌍인 항목을 나열한 시퀀스입니다.

{'key':'value'} : 일련의 키와 값을 쌍으로 리스트 형식과 튜플 형식을 모두 사용합니다.

항목 순서는 의미가 없으며, 키는 중복될 수 없습니다. 또한, 키는 수정될 수 없지만, 값은 수정될 수 있습니다.

✍ 코드

dict = {'사과':'apple', '곰':'bear'}
print(dict)

💻 출력

{'사과': 'apple', '곰': 'bear'}

키가 단순 문자열이면 간단히 월=’Monday’처럼 키 = 값 항목 나열로도 지정 가능합니다.

프로그램 내에서 똑같은 명령을 일정 횟수만큼 반복하여 수행하도록 제어하는 명령문
반복문에는 for문과 while문이 있다.

📚 for문

정해져 있는 시퀀스의 항목 값으로 반복을 실행

만약 여러 개의 값을 갖는 시퀀스에서 변수에 하나의 값을 순서대로 할당하며, 할당된 변수값을 갖고 블록의 문장들을 순차적으로 실행한다.

✍ 코드

for 변수 in 시퀀스:
    문장1
    문장2

✍ 코드

for A in range(3):
  print('반복문')

💻 출력

반복문
반복문
반복문

정해진 횟수만큼 실행 후 종료된다.

📚 while문

논리 표현식이 True인 동안 while문에 속한 문장들이 반복해서 수행

✍ 코드

while 논리 표현식:
    문장1
    문장2

✍ 코드

A = 0
while A < 3:
  print('반복 횟수는 {}번입니다.'.format(A + 1))
  A += 1

💻 출력

반복 횟수는 1번입니다.
반복 횟수는 2번입니다.
반복 횟수는 3번입니다.

반복문을 실행하다가 False일 경우 실행이 종료된다.

📚 break

break문 이후에 있는 문장들을 실행하지 않고 반복문을 종료하고 빠져나간다.

✍ 코드

A = 0
while True:
  if A >= 3:
      break
  print('반복 횟수는 {}번입니다.'.format(A + 1))
  A += 1

💻 출력

반복 횟수는 1번입니다.
반복 횟수는 2번입니다.
반복 횟수는 3번입니다.

📚 continue

continue문 이후의 문장은 실행하지 않고 다시 논리 표현식을 검사

✍ 코드

for A in range(1, 11):
  if A % 2 == 0:
    print('2의 배수인 {}입니다.'.format(A))
  continue
  print('저는 출력이 안됩니다.')

💻 출력

2의 배수인 2입니다.
2의 배수인 4입니다.
2의 배수인 6입니다.
2의 배수인 8입니다.
2의 배수인 10입니다.

파이썬 라이브러리로 인터프리터에서 아무런 설정 없이 바로 사용할 수 있는 함수들

다양한 함수들 중 많이 사용하는 함수 몇가지를 정리해봤다.

📚 min()

문자열을 구성하는 문자에서 코드 값으로 구분하여 최소값을 반환

✍ 코드

A = [3, 5, 8, 2, 1, 7]
print(min(A))

💻 출력

1

📚 max()

문자열을 구성하는 문자에서 코드 값으로 구분하여 최대값을 반환

✍ 코드

A = [3, 5, 8, 2, 1, 7]
print(max(A))

💻 출력

8

📚 range()

0부터 n-1까지 n개의 항목인 정수로 구성되는 시퀀스이다.

기본적으로 range(start, stop, step)형식으로 이루어져 있으며, step을 생략할 경우 기본적으로 1이 들어간다.

✍ 코드

for A in range(0, 11, 2):
  print(A)

💻 출력

0
2
4
6
8
10

0부터 10까지 2씩 증가하는 값을 출력한다.

📚 sorted()

리스트 항목의 순서를 정렬한 리스트를 반환하는 내장함수

✍ 코드

A = [3, 5, 8, 2, 1, 7]
print(sorted(A))

💻 출력

[1, 2, 3, 5, 7, 8]

기본적으로 오름차순으로 정렬해준다.

📚 zip()

몇 개의 리스트나 튜플의 항목으로 조합된 튜플을 생성

동일한 수로 이뤄진 여러 개의 튜플 항목 시퀀스를 각각의 리스트로 묶어 주는 역할이다.

✍ 코드

upper = ['A', 'B', 'C']
lower = ['a', 'b', 'c']
for A in zip(upper, lower):
  print(A)

💻 출력

('A', 'a')
('B', 'b')
('C', 'c')

이렇게 리스트로 묶어준 튜플은 자료형 zip이 되며, 간단히 리스트나 튜플로 변환한다.

📚 lambda

작고 이름이 없는(익명, Anonymous) 함수로 사용자 정의 함수와 비슷한 역할 이러한 람다 함수는 여러 개의 인자를 취할 수 있지만 표현식은 하나만 가능하다는 단점이 있다.

lambda 매개변수 : 표현식(expression)

사용자 정의 함수를 사용하게 된다면 아래와 같이 코드가 길어지게 된다. 이런 간단한 코드를 간추리기 위해 lambda 함수를 사용한다.

✍ 코드

def hap(x, y):
    return x + y
x, y = map(int, input().split())
hap(x, y)

💻 출력

2 3
5

이런 간단한 코드를 간추리기 위해 lambda 함수를 사용한다. 위 코드를 람다식으로 표현해보면 아래와 같다.

✍ 코드

(lambda x,y: x + y)(2, 3)

💻 출력

5

위와 같이 간단하게 정리된 코드를 볼 수 있다.

📚 map

여러 개의 데이터를 한 번에 다른 형태로 변환하기 위해 사용되며, 여러 개의 데이터를 담고 있는 list나 tuple을 대상으로 주로 사용하는 함수 map(변환 함수, 순회 가능한 데이터)

✍ 코드

x, y = map(int, input().split())
print(x)
print(y)

💻 출력

3 5
3
5

띄어쓰기를 기준으로 구분하여 리스트로 변환시켜 각 변수 x와 y에 값을 저장할 수 있다.

사용자가 직접 생성하여 사용할 수 있는 함수

📝 def

함수 정의 키워드

def 함수이름 (인자1, 인자2, …)

✍ 코드

def 함수이름 (인자1, 인자2, …)
    문장1
    문장2
    return 반환값1, 반환값2, … 

✍ 코드

def hello(name):
    print('안녕하세요. {}님 반갑워요! :)'.format(name))
hello('velog')

💻 출력

안녕하세요. velog님 반갑워요! :)

return값이 꼭 없어도 된다.

✍ 코드

def Calculate(x, y, c):
  if c == '+':
    return '결과는 {}입니다!'.format(x + y)
  elif c == '-':
    return '결과는 {}입니다!'.format(x - y)
  elif c == '*':
    return '결과는 {}입니다!'.format(x * y)
  elif c == '//':
    return '결과는 {}입니다!'.format(x // y)
Calculate(10, 5, '+')

💻 출력

결과는 15입니다!

return문으로 함수 기능을 수행한 후 반환 값을 전달한다.