Flask-Security中文文檔之快速入門

這是Flask-Security中文文檔翻譯第二波，再次聲明怜跑，此中文文檔全部由本人手擼翻譯。吠勘。性芬。
沒看過第一波的，點擊傳送門Flask-Security中文文檔之快速入門
后續(xù)文檔持續(xù)更新剧防。植锉。。

快速起步

  • 基礎(chǔ)的SQLAlchemy應(yīng)用
  • 基礎(chǔ)的SQLAlchemy會話應(yīng)用
  • 基礎(chǔ)的MongoEngine應(yīng)用
  • 基礎(chǔ)的Peewee應(yīng)用
  • 郵箱配置
  • 代理配置

基礎(chǔ)的SQLAlchemy應(yīng)用

SQLAlchemy安裝

$ mkvirtualenv <your-app-name>
$ pip install flask-security flask-sqlalchemy

SQLAlchemy應(yīng)用

以下代碼簡單地介紹了峭拘，如何通過SQLAlchemy快速使用Flask-Security:

from flask import Flask, render_template
from flask_sqlalchemy import SQLAlchemy
from flask_security import Security, SQLAlchemyUserDatastore, \
    UserMixin, RoleMixin, login_required

# 創(chuàng)建應(yīng)用（app）
app = Flask(__name__)
app.config['DEBUG'] = True
app.config['SECRET_KEY'] = 'super-secret'
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite://'

# 創(chuàng)建數(shù)據(jù)庫連接對象
db = SQLAlchemy(app)

# 定義模型
roles_users = db.Table('roles_users',
        db.Column('user_id', db.Integer(), db.ForeignKey('user.id')),
        db.Column('role_id', db.Integer(), db.ForeignKey('role.id')))

class Role(db.Model, RoleMixin):
    id = db.Column(db.Integer(), primary_key=True)
    name = db.Column(db.String(80), unique=True)
    description = db.Column(db.String(255))

class User(db.Model, UserMixin):
    id = db.Column(db.Integer, primary_key=True)
    email = db.Column(db.String(255), unique=True)
    password = db.Column(db.String(255))
    active = db.Column(db.Boolean())
    confirmed_at = db.Column(db.DateTime())
    roles = db.relationship('Role', secondary=roles_users,
                            backref=db.backref('users', lazy='dynamic'))

# 設(shè)置 Flask-Security
user_datastore = SQLAlchemyUserDatastore(db, User, Role)
security = Security(app, user_datastore)

# 創(chuàng)建一個用戶來測試一下
@app.before_first_request
def create_user():
    db.create_all()
    user_datastore.create_user(email='matt@nobien.net', password='password')
    db.session.commit()

# 視圖
@app.route('/')
@login_required
def home():
    return render_template('index.html')

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

基礎(chǔ)的SQLAlchemy會話應(yīng)用

SQLAlchemy安裝

$ mkvirtualenv <your-app-name>
$ pip install flask-security flask-sqlalchemy

SQLAlchemy應(yīng)用

以下代碼簡單地介紹了俊庇，如何通過SQLAlchemy快速使用Flask-Security:

我們將應(yīng)用分成了3個文件：app.py、database.py 鸡挠、models.py辉饱。你也可以創(chuàng)建一個文件夾來擴展你自己的代碼。
? app.py

from flask import Flask
from flask_security import Security, login_required, \
     SQLAlchemySessionUserDatastore
from database import db_session, init_db
from models import User, Role

# 創(chuàng)建應(yīng)用（app）
app = Flask(__name__)
app.config['DEBUG'] = True
app.config['SECRET_KEY'] = 'super-secret'

# 設(shè)置 Flask-Security
user_datastore = SQLAlchemySessionUserDatastore(db_session,
                                                User, Role)
security = Security(app, user_datastore)

# 創(chuàng)建一個用戶來測試一下
@app.before_first_request
def create_user():
    init_db()
    user_datastore.create_user(email='matt@nobien.net', password='password')
    db_session.commit()

# 視圖
@app.route('/')
@login_required
def home():
    return render('Here you go!')

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

? database.py

from sqlalchemy import create_engine
from sqlalchemy.orm import scoped_session, sessionmaker
from sqlalchemy.ext.declarative import declarative_base

engine = create_engine('sqlite:////tmp/test.db', \
                       convert_unicode=True)
db_session = scoped_session(sessionmaker(autocommit=False,
                                         autoflush=False,
                                         bind=engine))
Base = declarative_base()
Base.query = db_session.query_property()

def init_db():
    # 在此導(dǎo)入所有可能定義的模型宵凌，這樣他們將被正確注冊鞋囊。
    # 否則，你將必須在調(diào)用init_db()之前導(dǎo)入他們瞎惫。
    import models
    Base.metadata.create_all(bind=engine)

? models.py

from database import Base
from flask_security import UserMixin, RoleMixin
from sqlalchemy import create_engine
from sqlalchemy.orm import relationship, backref
from sqlalchemy import Boolean, DateTime, Column, Integer, \
                       String, ForeignKey

class RolesUsers(Base):
    __tablename__ = 'roles_users'
    id = Column(Integer(), primary_key=True)
    user_id = Column('user_id', Integer(), ForeignKey('user.id'))
    role_id = Column('role_id', Integer(), ForeignKey('role.id'))

class Role(Base, RoleMixin):
    __tablename__ = 'role'
    id = Column(Integer(), primary_key=True)
    name = Column(String(80), unique=True)
    description = Column(String(255))

class User(Base, UserMixin):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    email = Column(String(255), unique=True)
    username = Column(String(255))
    password = Column(String(255))
    last_login_at = Column(DateTime())
    current_login_at = Column(DateTime())
    last_login_ip = Column(String(100))
    current_login_ip = Column(String(100))
    login_count = Column(Integer)
    active = Column(Boolean())
    confirmed_at = Column(DateTime())
    roles = relationship('Role', secondary='roles_users',
                         backref=backref('users', lazy='dynamic'))

基礎(chǔ)的MongoEngine應(yīng)用

MongoEngine安裝

$ mkvirtualenv <your-app-name>
$ pip install flask-security flask-mongoengine

MongoEngine應(yīng)用

以下代碼簡單地介紹了溜腐，如何通過SQLAlchemy快速使用Flask-Security:

from flask import Flask, render_template
from flask_mongoengine import MongoEngine
from flask_security import Security, MongoEngineUserDatastore, \
   UserMixin, RoleMixin, login_required

# 創(chuàng)建應(yīng)用（app）
app = Flask(__name__)
app.config['DEBUG'] = True
app.config['SECRET_KEY'] = 'super-secret'

# MongoDB 配置
app.config['MONGODB_DB'] = 'mydatabase'
app.config['MONGODB_HOST'] = 'localhost'
app.config['MONGODB_PORT'] = 27017

# 創(chuàng)建數(shù)據(jù)庫連接對象
db = MongoEngine(app)

class Role(db.Document, RoleMixin):
   name = db.StringField(max_length=80, unique=True)
   description = db.StringField(max_length=255)

class User(db.Document, UserMixin):
   email = db.StringField(max_length=255)
   password = db.StringField(max_length=255)
   active = db.BooleanField(default=True)
   confirmed_at = db.DateTimeField()
   roles = db.ListField(db.ReferenceField(Role), default=[])

# 設(shè)置 Flask-Security
user_datastore = MongoEngineUserDatastore(db, User, Role)
security = Security(app, user_datastore)

# 創(chuàng)建一個用戶來測試一下
@app.before_first_request
def create_user():
   user_datastore.create_user(email='matt@nobien.net', password='password')

# 視圖
@app.route('/')
@login_required
def home():
   return render_template('index.html')

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

基礎(chǔ)的Peewee應(yīng)用

Peewee安裝

$ mkvirtualenv <your-app-name>
$ pip install flask-security flask-peewee

Peewee應(yīng)用

以下代碼簡單地介紹了，如何通過SQLAlchemy快速使用Flask-Security:

from flask import Flask, render_template
from flask_peewee.db import Database
from peewee import *
from flask_security import Security, PeeweeUserDatastore, \
    UserMixin, RoleMixin, login_required

# 創(chuàng)建應(yīng)用（app）
app = Flask(__name__)
app.config['DEBUG'] = True
app.config['SECRET_KEY'] = 'super-secret'
app.config['DATABASE'] = {
    'name': 'example.db',
    'engine': 'peewee.SqliteDatabase',
}

# 創(chuàng)建數(shù)據(jù)庫連接對象
db = Database(app)

class Role(db.Model, RoleMixin):
    name = CharField(unique=True)
    description = TextField(null=True)

class User(db.Model, UserMixin):
    email = TextField()
    password = TextField()
    active = BooleanField(default=True)
    confirmed_at = DateTimeField(null=True)

class UserRoles(db.Model):
    # 因為peewee沒有內(nèi)置的多對多關(guān)系瓜喇，我們需要這個中間類去連接user和role
    user = ForeignKeyField(User, related_name='roles')
    role = ForeignKeyField(Role, related_name='users')
    name = property(lambda self: self.role.name)
    description = property(lambda self: self.role.description)

# 設(shè)置 Flask-Security
user_datastore = PeeweeUserDatastore(db, User, Role, UserRoles)
security = Security(app, user_datastore)

# 創(chuàng)建一個用戶來測試一下
@app.before_first_request
def create_user():
    for Model in (Role, User, UserRoles):
        Model.drop_table(fail_silently=True)
        Model.create_table(fail_silently=True)
    user_datastore.create_user(email='matt@nobien.net', password='password')

# 視圖
@app.route('/')
@login_required
def home():
    return render_template('index.html')

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

郵箱配置

Flask-Security與Flask-Mail相結(jié)合去處理所有用戶與網(wǎng)站之間的郵箱通信挺益，所以為Flask-Mail配置您的郵箱服務(wù)信息是非常重要的。

下面的代碼展示了一個簡單的配置乘寒，您可以將下面的代碼直接加入您的Flask應(yīng)用代碼中:

# 在文件上面
from flask_mail import Mail

# 在'Create app'后
app.config['MAIL_SERVER'] = 'smtp.example.com'
app.config['MAIL_PORT'] = 465
app.config['MAIL_USE_SSL'] = True
app.config['MAIL_USERNAME'] = 'username'
app.config['MAIL_PASSWORD'] = 'password'
mail = Mail(app)

若想要了解更多Flask-Mail的配置信息望众，請閱讀Flask-Mail文檔。

代理配置

用戶追蹤特性需要在HTTP代理環(huán)境中添加一個額外的配置。下面的代碼展示了一個單個HTTP代理的配置烂翰。

# 在文件最上面
from werkzeug.config.fixers import ProxyFix

# 在'Create app'后
app.wsgi_app = ProxyFix(app.wsgi_app, num_proxies=1)

若想要了解更多關(guān)于ProxyFix的中間件夯缺，請閱讀Werkzeug文檔。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末甘耿，一起剝皮案震驚了整個濱河市踊兜，隨后出現(xiàn)的幾起案子，更是在濱河造成了極大的恐慌佳恬，老刑警劉巖捏境，帶你破解...
    沈念sama閱讀 206,723評論 6贊 481
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件，死亡現(xiàn)場離奇詭異毁葱，居然都是意外死亡垫言，警方通過查閱死者的電腦和手機，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,485評論 2贊 382
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門倾剿，熙熙樓的掌柜王于貴愁眉苦臉地迎上來筷频，“玉大人，你說我怎么就攤上這事柱告〗赝裕” “怎么了？”我有些...
    開封第一講書人閱讀 152,998評論 0贊 344
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵际度，是天一觀的道長葵袭。 經(jīng)常有香客問我，道長乖菱，這世上最難降的妖魔是什么坡锡？ 我笑而不...
    開封第一講書人閱讀 55,323評論 1贊 279
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮窒所，結(jié)果婚禮上鹉勒，老公的妹妹穿的比我還像新娘。我一直安慰自己吵取，他們只是感情好禽额，可當(dāng)我...
    茶點故事閱讀 64,355評論 5贊 374
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著皮官，像睡著了一般脯倒。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上捺氢，一...
    開封第一講書人閱讀 49,079評論 1贊 285
  • 城市分裂傳說
    那天藻丢，我揣著相機與錄音，去河邊找鬼摄乒。 笑死悠反，一個胖子當(dāng)著我的面吹牛残黑，可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播斋否，決...
    沈念sama閱讀 38,389評論 3贊 400
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼梨水，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了茵臭？” 一聲冷哼從身側(cè)響起冰木，我...
    開封第一講書人閱讀 37,019評論 0贊 259
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎笼恰，沒想到半個月后，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體歇终，經(jīng)...
    沈念sama閱讀 43,519評論 1贊 300
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡社证，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,971評論 2贊 325
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年，在試婚紗的時候發(fā)現(xiàn)自己被綠了评凝。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片追葡。...
    茶點故事閱讀 38,100評論 1贊 333
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖奕短，靈堂內(nèi)的尸體忽然破棺而出宜肉，到底是詐尸還是另有隱情，我是刑警寧澤翎碑，帶...
    沈念sama閱讀 33,738評論 4贊 324
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布谬返，位于F島的核電站，受9級特大地震影響日杈，放射性物質(zhì)發(fā)生泄漏遣铝。R本人自食惡果不足惜，卻給世界環(huán)境...
    茶點故事閱讀 39,293評論 3贊 307
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一莉擒、第九天 我趴在偏房一處隱蔽的房頂上張望酿炸。 院中可真熱鬧，春花似錦涨冀、人聲如沸填硕。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,289評論 0贊 19
  • 一樁弒父案鹿鳖，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽扁眯。三九已至，卻和暖如春栓辜，著一層夾襖步出監(jiān)牢的瞬間恋拍，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,517評論 1贊 262
  • 情欲美人皮
    我被黑心中介騙來泰國打工藕甩， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留施敢，地道東北人周荐。 一個月前我還...
    沈念sama閱讀 45,547評論 2贊 354
  • 代替公主和親
    正文 我出身青樓渺蒿，卻偏偏與公主長得像计福，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子艇抠，可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,834評論 2贊 345