02-Flask-用戶認證和角色管理-數據庫設計

認證管理

新建數據庫

create database `flasky` default character set utf8 collate utf8_general_ci;

須要的插件

flask-mail: 用來發送認證信息
flask-login: 用於管理session
werzeug+itsdangerous：用於密碼hash加鹽
flask-wtf：表單對象建立
flask-bootstrap： bootstrap 渲染

創建認證藍圖

# auth/__init__.py
# coding: utf-8 
from flask import Blueprint
auth_bp = Blueprint("/",__name__)
from . import views,routes,models

# app/__init__.py
def create_app(config_name):
    ...
    from app.auth import auth_bp
    app.register_blueprint(auth_bp)

創建用戶ORM模型

# auth/models.py
# coding: utf-8 
from werkzeug.security import generate_password_hash,check_password_hash
from app import db

class User(db.Model):
    __tablename__ = "users"
    id = db.Column(db.Integer,primary_key=True)
    username = db.Column(db.String(12))
    email = db.Column(db.String(50))
    password_hash = db.Column(db.String(128))
    role_id = db.Column(db.Integer,db.ForeignKey('roles.id'))
    
    @property
    def password(self):
        raise AttributeError("password is not readable attribute")
    
    @password.setter
    def password(self,password):
        self.password_hash = generate_password_hash(password)
    
    def verify_password(self,password):
        return check_password_hash(self.password_hash,password)

權限分配

權限等級設置

name	permission name	permission value
Follow users	FOLLOW	1
Comment on posts made by others	COMMENT	2
Write articles	WRITE	4
Moderate comments	MODERATE	8
Admin	ADMIN	16

直接新建一個 Permission 對象來表示權限

# auth/models.py
class Permission:
    FOLLOW = 1
    COMMENT = 2
    WRITE = 4
    MODERATE = 8
    ADMIN = 16

設置三種用戶角色

角色	權限	描述
None	None	只讀
User	FOLLOW/COMMENT/WRITE	基礎權限
Moderator	MODERATOR	只有一個修改評論權限
ADMIN	FOLLOW/COMMENT/WRITE/MODERATOR/ADMIN	多一個管理員權限

創建角色模型

# auth/models.py
# coding: utf-8 
from werkzeug.security import generate_password_hash,check_password_hash
from app import db

class Role(db.Model):
    __tablename__ == "roles"
    id = db.Column(db.Integer,primary_key=True)
    name = db.Column(db.String(10))
    default = db.Column(db.Boolean,default=False,index=True) # 只設置給一個用戶，其餘用戶都是False，由於app 會去搜索這個值，所以設置爲 index 方便查找
    permissions = db.Column(db.Integer)
    users = db.relationship('User',backref='role',lazy='dynamic')

    def __init__(self,**kw):
        super(Role,self).__init__(**kw)
        if self.permissions is None:
            self.permissions = 0

    # 判斷是否含有權限  
    def has_permission(self,perm):
        return self.permissions & perm == perm

    # 添加權限
    def add_permission(self,perm):
        if not self.has_permission(perm):
            self.permissions += perm
    # 移除權限
    def remove_permission(self,perm):
        if self.has_permission(perm):
            self.permissions -= perm

    # 重置權限
    def reset_permission(self):
        self.permissions = 0    
    
   
    # 插入角色
    @staticmethod
    def insert_roles():
        roles = {
            "User":[
                Permission.FOLLOW,
                Permission.COMMENT,
                Permission.WRITE,
            ],
            "Moderator":[
                Permission.MODERATE
            ],
            "ADMIN":[
                Permission.FOLLOW,
                Permission.COMMENT,
                Permission.WRITE,
                Permission.MODERATE,  
                Permission.ADMIN,          
            ]
        }
        # 默認角色是用戶
        default_role = 'User'
        for r in roles:
            # 搜索三種角色，在數據庫表的存在
            role = Role.query.filter_by(name=r).first()
            # 若是不存在這種角色，立刻添加進去，方便之後拓展
            if role is None:
                role = Role(name=r)
            
            # 重置權限
            role.reset_permission()
            for perm in roles[r]:
                # 權限從新一個個加進去
                role.add_permission(perm)
            
            # 將默認用戶寫進數據庫
            role.default = (role.name == default_role)
            db.session.add(role)
        
        db.session.commit()

而後是分配角色給用戶

# app/auth/models.py
class User(db.Model):
    def __init__(self,**kw):
    
        super(User,self).__init__(**kw)
        # 分配管理員角色
        if self.role is None and self.email == current_app.config['FLASKY_ADMIN']:
            self.role = Role.query.filter_by(name="ADMIN").first()

        # 若是一個用戶的角色不存在
        if self.role is None:
            # 分配一個默認角色
            self.role = Role.query.filter_by(default=True).first()
    
    # 判斷用戶角色
    def can(self,perm):
        return self.role is not None and self.role.has_permission(perm) 
    
    def is_administrator(self):
        return self.can(Permission.ADMIN)

接着要將這個插入角色的操做寫進deploy命令，後面使用 flask deploy 便可部署

# run.py
@app.cli.command()
def deploy():
    Role.insert_roles()

flask-migrate

pipenv install flask-migrate

運行建立數據庫表

flask db init 
flask db migrate -m "add users and roles table"
flask db upgrade

單元測試

先配置flask 命令

# run.py
@app.cli.command()
def test():
    import unittest
    tests = unittest.TestLoader().discover('tests')
    unittest.TextTestRunner(verbosity=2).run(tests)

新建 tests 文件夾 在根文件夾下

mkdir tests

新建單元測試文件

# tests/test_user_models.py
# 用戶模型測試腳本
import unittest
from app.auth.models import User

class UserModelTestCase(unittest.TestCase):
    def test_password_enter(self):
        u = User(password="cat")
        self.assertTrue(u.password_hash is not None)
    
    def test_no_password_getter(self):
        u = User(password='cat')
        with self.assertRaises(AttributeError):
            u.password
    
    def test_password_verification(self):
        u = User(password='cat')
        self.assertTrue(u.verify_password('cat'))
    
    def test_password_salts_are_random(self):
        u = User(password="cat")
        u1 = User(password = "cat")
        self.assertFalse(u1.password_hash == u.password_hash)

# 角色模型測試腳本
# tests/test_user_role.py
import unittest
from app.auth.models import Role,Permission,User

class TestUserRole(unittest.TestCase):
    def test_default_user(self):
        u = User(username="john",password="cat")
        self.assertTrue(u.can(Permission.COMMENT))
        self.assertTrue(u.can(Permission.WRITE))
        self.assertTrue(u.can(Permission.FOLLOW))
    
    def test_moderator_user(self):
        u = User(username="john_moder",password="123")
        u.role = Role.query.filter_by(name="Moderator").first()
        self.assertTrue(u.can(Permission.MODERATE))
        self.assertFalse(u.can(Permission.FOLLOW))
        self.assertFalse(u.can(Permission.COMMENT))
        self.assertFalse(u.can(Permission.WRITE))
    
    def test_admin_user(self):
        u = User(username="john_admin",password="123")
        u.role = Role.query.filter_by(name="ADMIN").first()
        self.assertTrue(u.can(Permission.MODERATE))
        self.assertTrue(u.can(Permission.FOLLOW))
        self.assertTrue(u.can(Permission.COMMENT))
        self.assertTrue(u.can(Permission.WRITE))
        self.assertTrue(u.can(Permission.ADMIN))

運行部署初始化和單元測試

flask deploy
flask test

代碼：https://github.com/TheFifthMa...

參考

推薦閱讀： 《OReilly.Flask.Web.Development.2nd.Edition》