[Flask] (1) Intro & URL Routing & Variable Rules & jsonify( )

📝 Flask

플라스크는 많은 사람이 "Micro Web Framework" 라고 부른다.
여기서 "Micro" = "프레임워크를 간결하게 유지하고 확장할 수 있도록 만들었다" 라는 의미

• Micro : 가벼운 기능 제공, 가볍게 배우고 가볍게 사용할 수 있으며, 확장성이 넓다.
• Framework : 이미 작성된 코드의 모임인 "라이브러리" 그 이상의 의미, 어플리케이션을 개발하기 위한 일정한 "뼈대"를 제공해주는 기술

간단한 웹 사이트, 간단한 API 서버를 만드는 데에 특화 되어있는 Python Web Framework 이다.
요즘은 클라우드 컴퓨팅의 발달로 Docker, Kubernetes와 접목해서, 소규모 컨테이너 단위로 기능 별 개발 후, 한꺼번에 배포하는 방식이나 배포 후 기능을 추가하는 식으로 자주 사용하고 있다.

💡 플라스크 장점

• 가볍게 배울 수 있다 : HTML/CSS/JS 알고, python을 어느정도 알고있다면, 빠르게 배울 수 있다.
• 가볍게 사용 가능하다. : 코드 몇 줄이면, 만들 수 있다.
• 가볍게 배포할 수 있다. : pip을 사용하여 Flask를 다운받고 배포하면 끝이다.

💡 플라스크의 단점

• Django에 비해서 자유도가 높으나, 제공해주는 기능이 덜 하다.
• 복잡한 어플리케이션을 만들려고 할 때, 해야 할 것들이 많다.

Flask는 소규모의 어플리케이션을 빠르게 만들 수 있고, 배포 환경에 따라 대규모 어플리케이션의 기능 확장의 역할을 하기 쉬운 장점이 있다.
반면, Django는 대규모 어플리케이션을 빠르게 만들 수 있으며, 기본으로 제공해 주는 기능이 많다.

Flask	Django
ORM 기능이 제공되지 않음	ORM 기능이 내장
짧은 코드로 웹 서버 구동가능	자동으로 관리자 화면 구성

ORM(Object Relational Mapping) : ORM은 DB와 OOP 언어 간의 호환되지 않는 데이터를 변환하는 프로그래밍 기법

 

📝 로컬에서 Simple Web Server띄우기 : Hello World !!

환경 : VS code, Python.exe 20.3.3 version 이상
(오류 발생시, 보통, 파이썬 실행파일 버젼이, 이전 버젼이어서 발생할 수 있으니 그럴 경우, 버젼 업그레이드 필요)

c:/python39/python.exe -m pip install --upgrade pip
c:/python39/python.exe -m pip install --upgrade pip --user (액세스 거부시)

성공 시, 아래와 같은 "Hello world!"를 보여주는 간단한, 플라스크 코드 작성

from flask import Flask  # 플라스크 import

app = Flask(__name__)   # app 이라는 이름의, flask앱을 하나 만들꺼야.

@app.route('/')             # 라우팅, '/'는 접속시, root 경로
def hello_World():          # '/'과 매칭되는 함수(root 경로일 시), 페이지에서 작동할 메소드
    return "Hello World!"

if __name__ == '__main__':  # 모듈 명이 "main"일 때만 실행하도록 조건문
    app.run()

127.0.0.1:5000(로컬) 에 출력된 Hello World

 

📝 Flask  HTTP 통신 : HTTP Methods

먼저 HTTP 개념을 모른다면 아래, 포스팅을 잠깐 읽고 오자. 

[Network] HTTP란 ?

Flask는 HTTP 통신을 위해 다음과 같은 Methods를 제공한다.

Method	설명
GET	암호화되지 않은 형태의 데이터를 서버로 전송하는데 사용되는 가장 일반적인 방법
HEAD	GET과 유사한 방법으로 Response Body를 포함지 않고 사용
POST	특정 양식의 데이터를 암호화하여 서버로 전송하는데 사용
PUT	특정 대상의 데이터를 갱신(Update)하는데 사용
DELETE	URL에 지정된 대상을 삭제(DELETE)하는데 사용

 

📝 URL Routing 이란 ?

URL Routing : 서버에서 특정 URL에 접속했을 시, 보여줄 페이지를 정해주는 것

즉, 특정 URL을 일부 작업을 수행하기 위한 관련된 기능과 "Mapping"하는 데 사용된다.

https://page.com/home  # 홈화면을 보여주고
https://page.com/login # 로그인화면을 보여준다.

위에 예시같은 것이, URL Routing 이다.

💡 Flask에서 URL Mapping을 어떻게 할까 ?

Flask에서 URL Routing은 @app.route(' ')를 통해 수행한다.
또한, 여기서 @를 통해 선언하는 방식 = 데코레이터(decorator)라고 부른다.

from flask import Flask  # 플라스크 import

app = Flask(__name__)   # app 이라는 이름의, flask앱을 하나 만들꺼야.

@app.route('/')             # 라우팅, '/'는 접속시, root 경로
def home():          # '/'과 매칭되는 함수(root 경로일 시), 페이지에서 작동할 메소드
    return "This is Home page !!"

@app.route('/hello')        # "/hello" URL 접속 시 
def hello():
    return "Hello world !!"
if __name__ == '__main__':  # 모듈 명이 "main"일 때만 실행하도록 조건문
    app.run()

localhost 페이지

localhost/hello 페이지

 

📝 Variable Rules

플라스크에서는 route( ) 를 사용해서 url path의 값을 활용할 수 있다.
url path의 문자열, 정수, 서브경로를 활용할 수 있다.

• 문자열은 사용할 변수명을 <변수명>으로 감싸주면 함수에서 전달받은 값을 활용할 수 있다.
• 정수는 <int:변수명> 형태로 사용이 가능하다.
• 서브경로는 <path:subpath> 형태로 사용이 가능하다.

from flask import Flask

app = Flask(__name__)

@app.route('/user/<username>')
def show_user_profile(username):
    return f"User {username}"

@app.route('/post/<int:post_id>')
def show_post(post_id):
    return f"Post {post_id}"

@app.route('/path/<path:subpath>')
def show_subpath(subpath):
    return f"Subpath {subpath}"

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

문자열  = <변수명>

 

정수 = <int:변수명>

서브경로 = <path:서브경로>

 

📝 데이터 반환하기 - jsonify( )

Flask 에서는 데이터를 json 파일 형식으로 데이터를 교환한다.

json 파일 형식은 웹 사이트 상에서 정보를 주고 받는 형식이다. Dictionary형태와 유사한 구조를 가진다.

Flask 에는 데이터를 json 형식으로 바꿔주는 jsonify( ) 메소드가 있다.

from flask import Flask, jsonify    # jsonify import

app = Flask(__name__)

@app.route('/')
def json():
    people = [
        {'name' : 'natto' , 'birth-year' : 2020},
        {'name' : 'apple' , 'birth-year' : 2021},
        {'name' : 'banana' , 'birth-year' : 2022}
    ]
    return jsonify(people)

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

jsonify( ) 반환 = json형식

 

📝 URL 설계하기 - URL Building

웹 사이트의 기본 구조를 설계하고 사용자들이 웹 사이트에 접속하기 위해 URL 구조를 설계할 필요성이 있다.

만약 한 페이지에서 다른 페이지로 이동할 수 있도록 "링크"를 생성하려면 어떻게 해야 할까 ?

Flask 에서는 url_for( ) 메소드를 통해 이를 수행한다.

url_for( ) 메소드 : 특정 함수에 대한 url을 "동적"으로 구축하는 데 사용한다.
일반적으로 url 끝점에 이동할 함수 이름과 점(.)을 접두사로 붙이는 것처럼 사용할 수 있다.

from flask import Flask, redirect, url_for

app = Flask(__name__)

# 홈 페이지로 이동
@app.route('/')
def home():
    return "주소창에 /user/admin과 /admin <br> /user/student 와 /student를 입력해보세요."

# 관리자 페이지로 이동
@app.route('/admin')
def admin():
    return "관리자 페이지 입니다."

@app.route('/student')
def student():
    return "학생용 페이지 입니다."

# redirect() 는 "페이지에 다시 연결한다"는 뜻으로 마치 페이지를 "새로고침" 한 것과 같은 동작한다.
@app.route('/user/<name>')
def user(name):
    # 전달 받은 name이 'admin'이라면 ?
    if name == 'admin':
        return redirect(url_for('admin'))
    
    # 전달 받은 name이 'student' 라면 ?
    if name == 'student':
        return redirect(url_for('student'))


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

/admin = /user/admin 같은 페이지를 보여준다.

/student = /user/studnet 같은 페이지를 보여준다.

다만, 차이는 터미널에서 볼 수 있듯이, "HTTP status code" 인 것 같다.

위에, HTTP 포스팅에서 설명했듯이

300 = "리다이렉트" , 200 = "성공" 을 의미한다.
두 경우 모두, GET Method를 사용한것은 공통점이다.