03_Oct_2021 🐰 엘리스 AI 트랙 TIL: Flask를 통한 서비스 다루기

유환익·2021년 11월 6일

Alexander Yoo의 Back-end Engineering

목록 보기

6/6

Blueprint와 Jinja Template

Blueprint

API들을 분류하고 관리한다.
Flask의 기능이 점점 늘어날수록, 자연스럽게 코드의 양이 증가한다.
이때, Blueprint를 사용해서 길어진 코드를 모듈화해주어 수정 개발과 유지보수에 용이하게 코드를 관리할 수 있게 해준다.

Blueprint를 사용하지 않았을 때의 예

from flask import Flask, jsonify
app = Flask(__name__)

@app.route('/', methods=['GET'])
def home_route():
	return jsonify('home')
    
@app.route('/first', methods=['GET'])
def first_route():
	return jsonify('first page')
...
if __name__ == '__main__':
	app.run(debug=True)

app.route의 개수가 API의 개수 (굉장히 많아진다)

Blueprint를 사용했을 때의 예

app.py

from flask import Flask
from first_api import bp

app = Flask(__name__)
app.register_blueprint(bp)

if __name__ == '__main__':
	app.run(debug==True)

from flask import Blueprint, jsonify
bp = Blueprint('bp', __name__)

@bp.route('/first', methods=['GET'])
def first_route():
	return jsonify('first page')
    
@bp.route('/second', methods=['GET'])
def second_route():
	return jsonify('second page')

app.py는 오로지 서버를 실행한다.
blueprint는 flask 서버와 연동, blueprint를 사용한 객체로 바로 라우팅 가능.
파일을 여러 개 효과적으로 개발할 수 있게 하여 유지보수적인 측면에서 이점을 가진다.
Flask의 요청으로 URL을 생성 할 때 화면을 출력하는 함수를 Blueprint와 연결하는 방식으로 사용한다.
API들을 따로 모아서 파이썬 파일들을 구성

Jinja2란?

Jinja2는 Python에서 가장 많이 사용되는 템플릿이다. 서버에서 받아온 데이터를 효과적으로 보여주고 비교적 간략한 표현으로 데이터를 가공할 수 있다.

render_template를 사용해서 템플릿에 데이터를 같이 보여준다.
HTML 내에서 파이썬 문법처럼 데이터를 불러내어 나타낼 수 있다.

Jinja2 Template에서 데이터 넘겨주기 - 단일변수

app.py

@app.route('/')
def alex():
	return render_template('index.html', data='alex')

<html>
    <head>
    	<title> jinja example</title>
        <body>
        	{{ data }}
        </body>
    </head>
</html>

Jinja2 Template에서 데이터 넘겨주기 - list

app.py

@app.route('/')
def alex():
	my_list = [1,2,3,4,5]
	return render_template('index.html', data=my_list)

index.html

<html>
    <head>
    	<title>jinja example</title>
    </head>
    <body>
    	{{ data }}
        {% for d in data %}
        	{{ d }}
        {% endfor %}
    </body>
</html>

Jinja2 Template에서 데이터 넘겨주기 - dictionary

app.py

@app.route('/')
def alex():
	my_data = {'name':'alex'}
	return render_template('index.html', data=my_data)

index.html

<html>
    <head>
    	<title>jinja example</title>
    </head>
    <body>
    	{{ data.get('name') }}
    </body>
</html>

게시판을 위한 CRUD 설계 및 제작

API 동작 원리

클라이언트는 HTTP request를 API 주소로 보내는 데, API 서버의 기능으로 어떤 응답을 들려줄 지 파악하고, 서버는 page나 JSON의 형태로 응답을 돌려준다.

클라이언트가 요청하는 모든 작업은 개인의 컴퓨터(브라우저)에서 이루어진다. 요청이 서버로 전달 될 때에는 HTTP request 형태로 넘어간다. 중간의 API 주소들은 서버에 매핑되어 있다.[@app.route()] 즉, 서버 안에서 API의 주소를 확인하고, 해당 기능을 수행하고 리턴 값을 돌려주는 것이 응답의 과정이다.

CRUD란?

Create : 데이터의 생성

Read : 데이터의 조회

Update : 데이터의 수정

Delete : 데이터의 삭제

를 뜻한다. 여기서 또 분류를 하자면, CREATE와 READ를 묶고, Update와 Delete를 함께 묶을 수 있다. 데이터를 다루는 기준으로 묶은 것이다.

Create는 데이터를 저장하는 연산이다.
Read는 데이터를 읽어오는 연산이다. (전체 혹은 하나를 읽을 수 있다.)
Update와 Delete는 본질적으로 저장하는 연산이나, 읽기 작업에 큰 비중을 가진 저장이다. (데이터를 먼저 읽어오고, 읽어온 데이터에 수정/삭제 연산을 한다.)

CRUD - API - DB 명령어 대응

CRUD	HTTP Method	DB 명령어
Create	POST	INSERT
Read	GET	SELECT
Update	PUT, PATCH, (POST)	UPDATE
Delete	DELETE	DELETE

Authentication이란?

Authentication vs Authorization

Authentication(인증)은 사용자가 어떠한 정보를 가지고 있는 사용자인지 알려주는 것을 의미한다 (ex. log-in, 2FA, OTP, SMS, PIN)
Authorization(권한)은 사용자가 어떠한 역할을 서버에서 할 수 있는 가를 뜻한다. 즉, 인증이 이루어진 후에 부여되는 것이다. (ex. 뱅킹 -> 예금, 송금, 인출 || 배달 -> 주문, 결제 || Mail -> 쓰기, 읽기, 삭제 || SNS -> '내가 쓴 글 수정')

Authentication

사용자가 누구인지 확인하는 절차이며, 대표적인 예로 회원가입하고 로그인 하는 과정이 있다.
1. 회원가입 -> 내 정보를 서버로 전송한다. create로 계정을 만들 때, 패스워드의 경우 암호화를 거쳐 저장된다.
2. 로그인 -> IP/PW를 입력하여 서버에 전송한다. 데이터베이스의 정보를 읽어, 전송한 정보랑 같은 것이 있는지 확인한다. 일치하면 로그인이 이루어진다. (session, JWT[token])
3. 로그아웃 -> 세션의 연결을 끊는다.

로그인 기능 구현

HTTP의 한계점을 극복하기 위한 데이터

클라이언트와 서버간의 통신에서 (요청/응답 == HTTP 통신의 한 사이클) 서버는 클라이언트의 접속 여부를 알 수 없다. HTTP는 상태 값을 저장하고 있지 않기 때문이다. 이러한 것을 저장하기 위해 쿠키로 저장하여 전송하는 것이고, 세션으로 식별하여 서버에서 관리하는 것이다.

쿠키

클라이언트에 저장되는 키/값이 들어 있는 데이터이다.

사용자가 따로 요청하지 않아도, Request 시에 자동으로 서버에 전송한다.
이때 쿠키는 클라이언트의 브라우저에 저장이 된다.

세션

쿠키를 기반으로 하지만 서버 측에서 관리하는 데이터이다.
클라이언트에 고유 ID를 부여하고 클라이언트에 알맞는 서비스를 제공한다. 서버에서 관리하기 때문에 보안이 쿠키보다 우수하다.

공통점: 사용자의 정보를 담고 있다.
차이점: 세션은 서버에서 관리하며, 쿠키는 클라이언트에서 관리한다.

로그인의 경우 세션에서 사용. 서버에서 관리.

user_id = request.form['user_id']
user_pw = request.form['user_pw']
user = {'user_id': 'elice', 'user_pw': '1234'}
if user is not None:
	if user_id == user['user_id'] and user_pw == user['user_pw']:
    		session['login'] = user.id
    		return jsonify({'result':'success'})
   	else:
    		return jsonify({'result':'fail'})

request로 받아온 로그인 정보(user_id, user_pw)를 변수에 저장한다.
데이터베이스에 user_id와 같은 데이터가 있는지 찾아온다.
입력된 user_pw와 저장된 패스워드가 같은지 체크한다.

session['login'] = None

로그아웃을 할 때는 정보를 받을 필요가 없다.
현재 저장된 session의 데이터를 비워 주면 기능이 완료된다.

로깅

프로그램이 작동할 때 발생하는 이벤트를 추적하는 행위이다.

이벤트: 프로그램의 기능, 동작

프로그램의 문제들을 파악하고 유지보수 하는 데 사용되며, 로깅을 통해 발생한 에러를 추적할 수 있다.

로깅 - level

DEBUG < INFO < WARNING < ERROR < CRITICAL : 오른쪽으로 갈수록 심각도가 높다.
기본 로거 레벨 세팅은 WARNING이기 때에 설정 없이 INFO, DEBUG를 출력할 수 없습니다.
(높은 순으로 설정되있을 수록 하위 레벨은 무시한다.)

DEBUG: 상세한 정보
INFO: 일반적인 정보
WARNING: 예상치 못하거나 가까운 미래에 발생할 문제
ERROR: 에러 로그. 심각한 문제
CRITICAL: 프로그램 자체가 실행되지 않을 수 있는 문제

import logging

if __name__ == '__main__':
	logger.info('hello elice!')

파이썬 디폴트 로깅 모듈을 사용한다.

import logging

if __name__ == '__main__':
	
    logger = logging.getLogger()
    logger.setlevel(logging.DEBUG)
    logger.info('hello elice!')
   #레벨을 수동으로 설정하고 출력하면 정상적으로 출력이 된다.

Flask에서 로깅

에러가 발생했을 때 Flask의 logger를 사용하여 에러를 확인 가능하다.

from flask import Flask
app = Flask(__name__)

if __name__ == '__main__':
	app.logger.info('test')
    app.logger.debug('debug test')
    app.logger.error('error test')
    app.run()

유환익

사용자의 편의를 더 생각하고 편안한 UI/UX 개발을 꿈꾸는 프론트엔드 개발자 지망생입니다.

이전 포스트

03_Oct_2021 🐰 엘리스 AI 트랙 TIL: Flask를 통한 서비스 다루기

Alexander Yoo의 Back-end Engineering

Blueprint와 Jinja Template

Blueprint

Blueprint를 사용하지 않았을 때의 예

Blueprint를 사용했을 때의 예

Jinja2란?

Jinja2 Template에서 데이터 넘겨주기 - 단일변수

Jinja2 Template에서 데이터 넘겨주기 - list

Jinja2 Template에서 데이터 넘겨주기 - dictionary

게시판을 위한 CRUD 설계 및 제작

API 동작 원리

CRUD란?

CRUD - API - DB 명령어 대응

Authentication이란?

Authentication vs Authorization

Authentication

로그인 기능 구현

HTTP의 한계점을 극복하기 위한 데이터

쿠키

세션

로깅

로깅 - level

Flask에서 로깅

27_Oct_2021 🐰 엘리스 AI 트랙 TIL: SQL과 함수

0개의 댓글