flask用户头像、文件上传下载

2020-12-14 19:54:36 编辑 0 阅读量:1011

在一个比较完善的web系统中，一般都会有用户系统，也会有用户头像之类的需求。

#### 一、需求
- 前后端分离
- 考虑到如果有上万的用户，就是可扩展性
- 上传由flask处理，展示头像则交给nginx来，所以目录在static中
- 文件上传不是很大，太大的需要换种方式

#### 二、用户头像实现
采用flask-uploads来实现，就不用自己造轮子了

头像目录和文件名的处理：
- 一个目录下的文件数过多会影响效率，所以这里分为1000个目录保存，用户hash(email) % 1000来，不用user.id是因为刚注册时id还未生成
- 为了反爬，所以文件都用hash值而不用{id}.jpg等
- 后缀还是采用用户上传的后缀，但是这些后缀要符合一定的标准

代码流程如下
```
# 设计数据库
class User(db.Model):
    __tablename__ = 'users'
    id = db.Column(db.Integer, primary_key=True)
    email = db.Column(db.String(64), unique=True, index=True)
    username = db.Column(db.String(64), unique=True, index=True)
    role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))
    password_hash = db.Column(db.String(128))
    avatar = db.Column(db.String(255))  #  存的是相对于项目根目录的相对路径
	
	def info(self):
	"""这里可以直接返回头像的地址，让前端直接请求，nginx去处理这些请求"""
        info = {
            "email": self.email,
            "username": self.username,
            "avatar": self.avatar
        }
        return info
		
# flask-uploads的一些配置
class AppConfig(object):
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'hard to guess string'

# 使用sqlite是无法使用pool_size等参数
    SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'data.db')
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    SQLALCHEMY_ECHO = False  # 是否显示sqlalchemy的log，适用于debug

# uploads的配置
    UPLOADS_DEFAULT_DEST = os.path.join(basedir, 'media')
    # 对于没有指定路径的set，默认会在UPLOADS_DEFAULT_DEST后面加上set的名字
    # 为flask-upload 的set为photos设置的地址，如果set名字为file, 那么就是UPLOADED_FILE_DEST
    UPLOADED_PHOTOS_DEST = basedir  # 在使用的时候加上Constant.avatar_basedir
    MAX_CONTENT_LENGTH = 32 * 1024 * 1024  # 1MB, 全局的，用户头像上传时还要单独判断一下

# 初始化
from flask_uploads import UploadSet, IMAGES, configure_uploads, ALL
photos = UploadSet('photos', IMAGES)  # 'photos'就是flask-uploads set的名字
files = UploadSet('files', ALL)  # 路径是default加上set name

def createApp():
    configure_uploads(app, photos)
    configure_uploads(app, files)
    from .user.view import user  # 不能放外面，否则会互相依赖
    app.register_blueprint(user, url_prefix='/user')
    return app

# 使用
def saveAvatar(user, img):
    """根据Email生成头像的路径和文件名"""
    if len(img.read()) > Constant.avatar_max_size:  # 如果没有files，可以在全局变量MAX_CONTENT_LENGTH里面设置头像的大小限制
        logger.warn("avatar too big")
        raise(ValueError)
    suffix = img.filename.split('.')[-1]
    filename = '{}.{}'.format(hash(user.email), suffix)
    folder = str(user.id % Constant.avatar_folder_size)  # 一个目录下的文件过多会影响读文件效率
    folder = os.path.join(Constant.avatar_basedir, folder)
    filename = photos.save(img, folder=folder, name=filename)  # 返回的是folder加上name的完整目录
    logger.info("avatar name: %s", filename)
    return filename
	
@user.route("/regist", methods=["POST"])
def regist():
    """注册过程有缺陷，要加上confirm等"""
    email = requestPostParam(request, 'email')
    password = requestPostParam(request, 'password')
    img = request.files.get("img", None)
    logger.info("email: %s, img: %s", email, img)
    if None in (email, password, img):
        return webJson(RetCode.PARAMS_ERROR)
    if User.query.filter_by(email=email).first():
        logger.warn('email duplication')
        return webJson(RetCode.EMAIL_DUPLICATION)

user = User(email=email, password=password)
    db.session.add(user)
    db.session.commit()
    try:
        avatar = saveAvatar(user, img)
    except UploadNotAllowed:
        return webJson(RetCode.FILE_SUFFIX_ERROR)
    except ValueError:
        return webJson(RetCode.AVATAR_TOO_BIG)
    user.avatar = avatar
    db.session.add(user)
    db.session.commit()
    return webJson(RetCode.SUCCESS)

@user.route('/login', methods=['GET', 'POST'])
def login():
    user_info = g.user.info()  # 前端可以根据返回的头像地址加上域名去拼接请求的地址
    user_info["token"] = g.user.generate_auth_token()
    return webJson(RetCode.SUCCESS, data=user_info)
```

# 三、文件上传、下载实现
```
@user.route('/upload', methods=["POST"])
def test_upload():
    upload_file = request.files.get("files", None)
    logger.info('---%s', upload_file)
    filename = files.save(upload_file)
    # 如果是多文件上传
    # for filename in request.files.getlist('photo'):
        # photos.save(filename)
    logger.info(filename)
    logger.info("path: %s", files.path(filename))
    logger.info("url: %s", files.url(filename))
    return webJson(RetCode.SUCCESS)
	
@user.route('/download', methods=["GET"])
def test_download():
    """这里只能下载英文格式的文件，而且效率低下，需要用X-Sendfile的方式让nginx代理"""
    filename = requestGetParam(request, 'file')
    filename_path = files.path(filename)
    logger.info('________: %s', filename_path)
    return send_file(filename_path, as_attachment=True)

```

完整的代码请看：[github-caitinggui/flask-user](https://github.com/caitinggui/flask-user)

---
参考：
- [1][Flask-Uploads¶](https://pythonhosted.org/Flask-Uploads/)
- [2][Flask-Uploads文件上传的简单使用](https://www.jianshu.com/p/9d6da9b76d70)
- [3][Flask 上传自定义头像_1 使用Flask Uploads](http://blog.csdn.net/bestallen/article/details/52891977)
- [4][<flask web>的flasky项目的头像问题](https://segmentfault.com/q/1010000009708509/a-1020000009716260)
- [5][Flask-Uploads使用教程，教你轻松上传文件](http://pysaber.com/2017/06/08/Flask-Uploads%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B%EF%BC%8C%E6%95%99%E4%BD%A0%E8%BD%BB%E6%9D%BE%E4%B8%8A%E4%BC%A0%E6%96%87%E4%BB%B6/)
- [6][ flask-文件上传/下载](http://blog.csdn.net/qq_25730711/article/details/53643758)
- [7][Flask文件上传（四）：文件管理与多文件上传](https://zhuanlan.zhihu.com/p/24429519?refer=flask)
- [8][请教哈 用户头像怎么存储的？](https://www.oschina.net/question/104204_36446)
- [9][Nginx与X-Sendfile](https://www.cnblogs.com/duanxz/p/4254945.html)
- [10][Flask下载文件](https://www.cnblogs.com/we8fans/p/7107353.html)

flask用户头像、文件上传下载

附件: