flask实现用户名查重,重复的用户名阻止注册,以及如何优化

发布于:2025-02-10 ⋅ 阅读:(71) ⋅ 点赞:(0)

在 Flask 中实现用户名查重,并阻止重复的用户名进行注册,可以使用数据库(如 SQLite、MySQL、PostgreSQL)存储用户信息,并在注册时检查用户名是否已存在。以下是实现步骤:


1. 安装 Flask 及 SQLAlchemy

确保已安装 Flask 及 Flask-SQLAlchemy:

pip install flask flask-sqlalchemy

2. 创建 Flask 应用并设置数据库

from flask import Flask, request, jsonify
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///users.db'  # 使用 SQLite
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
db = SQLAlchemy(app)

# 用户模型
class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), unique=True, nullable=False)

# 初始化数据库
with app.app_context():
    db.create_all()

3. 实现注册接口,检查用户名是否存在

@app.route('/register', methods=['POST'])
def register():
    data = request.get_json()
    username = data.get('username')

    if not username:
        return jsonify({'error': '用户名不能为空'}), 400

    # 查重
    existing_user = User.query.filter_by(username=username).first()
    if existing_user:
        return jsonify({'error': '用户名已存在'}), 409

    # 创建新用户
    new_user = User(username=username)
    db.session.add(new_user)
    db.session.commit()

    return jsonify({'message': '注册成功', 'username': username}), 201

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

4. 测试 API

(1) 注册新用户

curl -X POST http://127.0.0.1:5000/register -H "Content-Type: application/json" -d '{"username": "test_user"}'

返回成功

{
    "message": "注册成功",
    "username": "test_user"
}

(2) 注册相同的用户名

curl -X POST http://127.0.0.1:5000/register -H "Content-Type: application/json" -d '{"username": "test_user"}'

返回错误

{
    "error": "用户名已存在"
}

总结

  • 使用 Flask-SQLAlchemy 进行数据库管理。
  • 在注册时通过 User.query.filter_by(username=username).first() 查找是否已有该用户名。
  • 如果用户名已存在,返回 409 Conflict,否则插入新用户。

这样就能有效地防止用户名重复注册!

如果想让用户名查重和注册更高效,可以从以下几个方面优化:

优化方案

  1. 数据库层级的唯一索引
    • 直接在数据库表中给 username 添加唯一索引,让数据库自动处理冲突,避免重复查询。
  2. 使用事务
    • 通过事务处理,确保数据一致性,避免竞态条件导致的重复注册。
  3. 缓存+数据库双层校验
    • 使用 Redis 缓存用户名,提高查询效率,减少数据库压力。

1. 使用数据库唯一约束

修改模型,添加唯一索引

from flask import Flask, request, jsonify
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///users.db'  # SQLite数据库
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
db = SQLAlchemy(app)

# 用户模型,添加唯一索引
class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), unique=True, nullable=False)  # 唯一索引

# 初始化数据库
with app.app_context():
    db.create_all()

# 注册接口
@app.route('/register', methods=['POST'])
def register():
    data = request.get_json()
    username = data.get('username')

    if not username:
        return jsonify({'error': '用户名不能为空'}), 400

    try:
        new_user = User(username=username)
        db.session.add(new_user)
        db.session.commit()  # 依赖数据库的唯一索引,避免重复插入
        return jsonify({'message': '注册成功', 'username': username}), 201
    except Exception as e:
        db.session.rollback()  # 事务回滚
        return jsonify({'error': '用户名已存在'}), 409  # 直接返回冲突状态码

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

优化点

  • 不手动查重,直接尝试插入,数据库 unique=True 会强制唯一性,减少一次查询。
  • 异常处理:如果数据库抛出 IntegrityError,说明用户名已存在,直接返回 409 Conflict,并回滚事务。

2. 使用 Redis 缓存,提高查重效率

对于高并发场景,频繁查询数据库的效率较低,可以使用 Redis 作为缓存。

安装 Redis 及 Flask-Redis

pip install redis flask-redis

修改代码,增加 Redis 缓存

import redis
from flask_redis import FlaskRedis

app.config['REDIS_URL'] = "redis://localhost:6379/0"
redis_client = FlaskRedis(app)

@app.route('/register', methods=['POST'])
def register():
    data = request.get_json()
    username = data.get('username')

    if not username:
        return jsonify({'error': '用户名不能为空'}), 400

    # **先查询 Redis 缓存**
    if redis_client.exists(f"user:{username}"):
        return jsonify({'error': '用户名已存在'}), 409

    try:
        new_user = User(username=username)
        db.session.add(new_user)
        db.session.commit()

        # **插入数据库后更新 Redis 缓存**
        redis_client.set(f"user:{username}", "1", ex=3600)  # 缓存1小时
        return jsonify({'message': '注册成功', 'username': username}), 201
    except Exception as e:
        db.session.rollback()
        return jsonify({'error': '用户名已存在'}), 409

优化点

  1. 先查 Redis,如果 Redis 中已存在该用户名,则直接返回错误,避免查询数据库,提高效率。
  2. 数据库写入成功后,再更新 Redis 缓存,确保数据一致性。
  3. Redis 设置过期时间,防止缓存占用过多内存。

性能对比

方案 查重方式 查询次数 适用场景
传统方式 SQL 查询 User.query.filter_by(username=username).first() 2次(查询+插入) 低并发场景
数据库唯一索引 直接插入,依赖 unique=True 1次(插入失败时回滚) 中等并发场景
Redis + 数据库 先查 Redis,Redis 无命中再查数据库 最多 1 次数据库查询 高并发场景

总结

  • 普通场景(单机应用):仅使用数据库唯一索引 (unique=True),避免额外的 SQL 查询。
  • 高并发场景:结合 Redis 缓存,先查 Redis,再查数据库,减少数据库查询压力。

这样就能在保证唯一性的同时,提高性能!


网站公告

今日签到

点亮在社区的每一天
去签到