パッケージ化して本番公開 — Railway へのデプロイ
この章では、アプリケーションファクトリパターン、本番環境の設定を学び、Railway を使って Flask ブログをデプロイして本番公開します。
アプリケーションファクトリパターン create_app()
これまで、app.py で直接作成していましたapp = Flask(__name__)。これは開発時には十分ですが、いくつか問題があります:
- テスト時に独立した app インスタンスを作成できない
- 環境(開発/テスト/本番)ごとに異なる設定を切り替えられない
- 拡張機能の初期化が app インスタンスと密結合している
アプリケーションファクトリパターンこれらの問題を解決します:app の作成を関数にカプセル化します。
例
# ファイルパス:app/__init__.py
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_login import LoginManager
from flask_migrate import Migrate
from config import Config
db = SQLAlchemy()
login_manager = LoginManager()
migrate = Migrate()
def create_app(config_class=Config):
"""アプリケーションファクトリ:設定クラスに基づいて Flask アプリインスタンスを作成する"""
app = Flask(__name__)
app.config.from_object(config_class)
# 拡張機能を初期化(先に app インスタンスを作成し、その後拡張機能を app にバインドする)
db.init_app(app)
login_manager.init_app(app)
migrate.init_app(app, db)
login_manager.login_view = 'auth.login'
login_manager.login_message = '先にログインしてからアクセスしてください。'
# Blueprint を登録
from app.blueprints.main import main_bp
from app.blueprints.posts import posts_bp
from app.blueprints.auth import auth_bp
from app.blueprints.user import user_bp
app.register_blueprint(main_bp)
app.register_blueprint(posts_bp)
app.register_blueprint(auth_bp)
app.register_blueprint(user_bp)
# user_loader は app が存在した後に定義する必要がある
from app.models import User
@login_manager.user_loader
def load_user(user_id):
return User.query.get(int(user_id))
return app
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_login import LoginManager
from flask_migrate import Migrate
from config import Config
db = SQLAlchemy()
login_manager = LoginManager()
migrate = Migrate()
def create_app(config_class=Config):
"""アプリケーションファクトリ:設定クラスに基づいて Flask アプリインスタンスを作成する"""
app = Flask(__name__)
app.config.from_object(config_class)
# 拡張機能を初期化(先に app インスタンスを作成し、その後拡張機能を app にバインドする)
db.init_app(app)
login_manager.init_app(app)
migrate.init_app(app, db)
login_manager.login_view = 'auth.login'
login_manager.login_message = '先にログインしてからアクセスしてください。'
# Blueprint を登録
from app.blueprints.main import main_bp
from app.blueprints.posts import posts_bp
from app.blueprints.auth import auth_bp
from app.blueprints.user import user_bp
app.register_blueprint(main_bp)
app.register_blueprint(posts_bp)
app.register_blueprint(auth_bp)
app.register_blueprint(user_bp)
# user_loader は app が存在した後に定義する必要がある
from app.models import User
@login_manager.user_loader
def load_user(user_id):
return User.query.get(int(user_id))
return app
設定ファイル config.py
例
# ファイルパス:config.py
import os
from dotenv import load_dotenv
# .env ファイルから環境変数を読み込む(開発環境のみ使用)
load_dotenv()
class Config:
SECRET_KEY = os.environ.get('SECRET_KEY', 'dev-secret-key')
SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL', 'sqlite:///blog.db')
SQLALCHEMY_TRACK_MODIFICATIONS = False
class DevelopmentConfig(Config):
DEBUG = True
class ProductionConfig(Config):
DEBUG = False
# 環境変数に基づいて設定を選択
config_map = {
'development': DevelopmentConfig,
'production': ProductionConfig,
'default': DevelopmentConfig
}
import os
from dotenv import load_dotenv
# .env ファイルから環境変数を読み込む(開発環境のみ使用)
load_dotenv()
class Config:
SECRET_KEY = os.environ.get('SECRET_KEY', 'dev-secret-key')
SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL', 'sqlite:///blog.db')
SQLALCHEMY_TRACK_MODIFICATIONS = False
class DevelopmentConfig(Config):
DEBUG = True
class ProductionConfig(Config):
DEBUG = False
# 環境変数に基づいて設定を選択
config_map = {
'development': DevelopmentConfig,
'production': ProductionConfig,
'default': DevelopmentConfig
}
新しいエントリファイル wsgi.py
例
# ファイルパス:wsgi.py
from app import create_app
app = create_app()
from app import create_app
app = create_app()
これで起動方法は次のようになります:
(venv) $ flask --app wsgi run --debug # 开发模式 (venv) $ gunicorn wsgi:app # 生产模式(Gunicorn)
注意:import の順序として、Blueprint と user_loader は create_app() 内でインポートする必要があります(ファイルの先頭ではなく)。そうしないと循環インポートが発生します(Blueprint が models を参照し、models が db を参照しますが、db はこの時点ではまだ app にバインドされていません)。
requirements.txt と Procfile を生成する
(venv) $ pip freeze > requirements.txt
ファイルに重要な依存関係が含まれていることを確認してください:Flask、Flask-SQLAlchemy、Flask-Migrate、Flask-Login、Flask-WTF、Flask-Admin、gunicorn、python-dotenv。
プロジェクトのルートディレクトリに作成するProcfile:
web: gunicorn wsgi:app
プロジェクトを GitHub にプッシュする
$ git init $ echo "venv/" > .gitignore $ echo "__pycache__/" >> .gitignore $ echo "*.pyc" >> .gitignore $ echo "instance/" >> .gitignore $ echo ".env" >> .gitignore $ git add . $ git commit -m "初始化 Flask 博客项目" $ git branch -M main $ git remote add origin https://github.com/你的用户名/flask-blog.git $ git push -u origin main
必ず
.envに追加してください.gitignore。.env ファイルには SECRET_KEY などの機密情報が含まれています。一度 GitHub にコミットすると完全に削除することはできません(Git の履歴に残ります)。
Railway へのデプロイ
- アクセスrailway.app、GitHub でログイン
- New Project → Deploy from GitHub repo → flask-blog を選択
- Railway は Procfile を自動検出し、Gunicorn の起動コマンドを認識します
- Variables で環境変数を設定
- Deploy をクリック
環境変数の設定
| 変数名 | 值 | 説明 |
|---|---|---|
| SECRET_KEY | ランダムに生成された長い文字列 | Session と CSRF Token を暗号化する |
| DATABASE_URL | Railway によって自動的に注入される | 本番データベース(Railway が PostgreSQL を提供) |
| FLASK_ENV | production | 本番環境フラグ |
SECRET_KEY をすばやく生成する:
$ python -c "import secrets; print(secrets.token_urlsafe(50))"
デプロイが成功すると、次のようなリンクが取得されますhttps://flask-blog.up.railway.app。
次の学習方向
| 学習方向 | 適している人 | 推奨される開始点 |
|---|---|---|
| Flask REST API | フロントエンドフレームワーク(Vue3/React)向けの API を構築する | render_template の代わりに jsonify を使用し、RESTful API を構築する |
| Flask + Vue3/React のフロントエンド/バックエンド分離 | Flask をバックエンド、Vue3/React をフロントエンドとして使用したい | Flask が JSON API を提供し、フロントエンドは fetch で通信する |
| PostgreSQL | 本番レベルのデータベースが必要 | SQLite を置き換え、psycopg2 をインストールし、DATABASE_URL を変更する |
| Docker デプロイ | コンテナ化デプロイ | Dockerfile を作成し、docker-compose でオーケストレーションする |