基于 oracle 的 flask 项目（一）——配置项目

一般印象，flask 项目适合做一些短小精悍的项目，特别是与 sqlite、mysql 等数据库结合很是般配。但是在一些大公司，特别是一些金融行业等国企公司，还是以 oracle 居多，那么，这个小辣椒（flask）就无用武之地了吗？No, No, No...
下面将以 flask_oracle 项目为例，对 flask 的功能进行一个详细的讲解。

项目描述

• 实现登录功能，基于 flask-login。
• 不同的权限管理，管理员能看到本部门所有人的信息。
• 查询功能，日期查询。
• 生成报表，不同的查询结果生成不同的报表。

配置项目的开发环境

配置 flask 虚拟环境

项目实例系统是 ubuntu 17.04， python是 3.6.3 版本

$ virtualenv -p /usr/bin/python3 env
$ source env/bin/activate
(env)$ pip install flask # 在虚拟环境中安装 flask 及插件
(env)$ pip install flask-login
(env)$ pip install flask-script
(env)$ pip install flask-wtf
(env)$ pip install flask-sqlalchemy
(env)$ pip install pyexcel
(env)$ pip install pyexcel-xls
(env)$ pip install cx-Oracle

提示： 其它的插件，如有需要，请自行安装，该处没有安装 flask-migrate 插件，因为在实际项目中，oracle 数据库是共用的，用 flask-migrate 创建及升级数据库会导致很多不必要的麻烦，极端情况会删除在 models.py 中未进行类定义的表，请慎用。

配置 cx_Oracle

从https://oracle.github.io/odpi/doc/installation.html#linux下载 oracle 客户端，然后解压后放入自己指定的目录。

sudo apt-get install libaio1 # ubuntu 中使用该命令安装，如果是 centos， 请使用 yum install libaio

export LD_LIBRARY_PATH=/home/ousikongjian/software/oracle/instantclient_12_2:$LD_LIBRARY_PATH # 该条命令重启后会不起作用，请使用下面的命令，两条命令二选一即可。

sudo sh -c "echo /home/ousikongjian/software/oracle/instantclient_12_2 > /etc/ld.so.conf.d/oracle-instantclient.conf" #  请注意 oracle 客户端的路径问题。

sudo ldconfig

配置 pycharm 的 deployment 功能

该方法不在赘述，请参看本人的博客文章——使用 pycharm deployment 功能远程调试代码

配置 flask 项目

目录结构

尽管该项目是一个展示项目，但是为了更贴近实际，还是使用了蓝图的功能。

flask_oracle
    |-- app
        |-- show # 蓝图文件夹
            |-- __init__.py
            |-- views.py
            |-- forms.py
        |-- templates # 模板文件夹
            |-- show # 蓝图的模板文件夹
            |-- ... # 其它蓝图的模板文件夹
        |-- __init__.py
    |-- config.py
    |-- manage.py

配置数据库

　让 flask 连接 Oracle 数据库

涉及到 config.py 的主要内容如下：

import os
import hashlib


class Config(object):
    os.environ['NLS_LANG'] = 'SIMPLIFIED CHINESE_CHINA.UTF8'
    SQLALCHEMY_POOL_SIZE = 20 #数据库连接池的大小。默认是引擎默认值（通常 是 5 ），此处最重要。
    SQLALCHEMY_POOL_TIMEOUT = 5 # 指定数据库连接池的超时时间。默认是10s。
    SQLALCHEMY_POOL_RECYCLE = 3000 # 配置连接池的 recyle 时间。默认是7200s。
    SECRET_KEY = os.environ.get('SECRET_KEY') or hashlib.new(name='md5', string='ousi keji hawk@#').hexdigest()
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    SQLALCHEMY_COMMIT_ON_TEARDOWN = True
    OUSI_POSTS_PER_PAGE = 100


    @staticmethod
    def init_app(app):
        pass

问题描述参见： flask_sqlalchemy 使用 cx_oralce 连接数据超时的问题？

配置数据库的映射类

主要涉及到 models.py 的内容如下：

# -*- coding:utf-8 -*-
__author__ = '东方鹗'
__blog__ = u'http://www.os373.cn'


from . import db
from flask_login import UserMixin, AnonymousUserMixin, current_user
from . import login_manager


@login_manager.user_loader
def load_user(user_id):
    return OusiStaff.query.get(int(user_id))


class OusiStaff(UserMixin, db.Model):
    __tablename__ = 'ousi_staff'
    sid = db.Column(db.Integer, primary_key=True)
    department = db.Column(db.String(8))
    name = db.Column(db.String(8))
    password = db.Column(db.String(8))
    phone = db.Column(db.String(11))
    role = db.Column(db.String(8))

    def is_admin(self):
        return self.role == 'admin'


class AnonymousUser(AnonymousUserMixin):
    def is_admin(self):
        return False


login_manager.anonymous_user = AnonymousUser


class OusiGuest(db.Model):
    __tablename__ = 'ousi_guest'
    id = db.Column(db.Integer, primary_key=True)
    staff_phone = db.Column(db.String(11))
    name = db.Column(db.String(8))
    month = db.Column(db.String(8))
    balance = db.Column(db.Integer)

在 oracle 中创建相关数据库

1、 创建表 —— ousi_staff （用户表），并实现 sid 的序列化自增功能，自增的阶梯为 1，因为 sqlalchemy 要求必须得有主键。

---------------------------create ousi_staff-------------

-- 创建 ousi_staff 表
create table ousi_staff(
       sid number primary key,  
       department varchar2(8),
       name varchar2(8),
       password varchar2(8),
       phone varchar2(11),
       role varchar2(8)
)
-- 创建 seq_ousi_staff 序列
create sequence seq_ousi_staff
-- 创建 tg_ousi_staff 触发器
create or replace trigger tg_ousi_staff before
  INSERT ON ousi_staff FOR EACH row
DECLARE integrity_error EXCEPTION;
  errno  INTEGER;
  errmsg CHAR(200);
  dummy  INTEGER;
  found  BOOLEAN;
BEGIN
  --  Column sid uses sequence seq_ousi_staff
  SELECT seq_ousi_staff.NEXTVAL
  INTO :new.sid -- 注意 id 的名称
  FROM dual;
  --  Errors handling

EXCEPTION
WHEN integrity_error THEN
  raise_application_error(errno, errmsg);
END;

2、 创建表 —— ousi_guest （客户表），并实现 id 的序列化自增功能，自增的阶梯为 1，因为 sqlalchemy 要求必须得有主键。

---------------------------create ousi_guest-------------

-- 创建 ousi_guest 表
create table ousi_guest(
       id number primary key,  
       staff_phone varchar2(11),
       name varchar2(8),
       month varchar2(8),
       balance number
)
-- 创建 seq_ousi_guest 序列
create sequence seq_ousi_guest
-- 创建 tg_ousi_guest 触发器
create or replace trigger tg_ousi_guest before
  INSERT ON ousi_guest FOR EACH row
DECLARE integrity_error EXCEPTION;
  errno  INTEGER;
  errmsg CHAR(200);
  dummy  INTEGER;
  found  BOOLEAN;
BEGIN
  --  Column id uses sequence seq_ousi_guest
  SELECT seq_ousi_guest.NEXTVAL
  INTO :new.id
  FROM dual;
  --  Errors handling

EXCEPTION
WHEN integrity_error THEN
  raise_application_error(errno, errmsg);
END;

提示： 建立的数据库有坑，对 flask-login 有影响，彩蛋将在以后的章节中揭晓。

其它配置内容（如模板，试图函数等）不在赘述，请查看 源码01。表中的数据，请参见源码里的 database.xlsx。

启动项目

如下图所示，上传本地文件到远程主机。

配置启动项。

启动项目，你将看到如图所示内容。

源码下载