基于阿里egg框架搭建博客（3）——注册与登录

相关文章

基于阿里egg框架搭建博客（1）——开发准备
基于阿里egg框架搭建博客（2）——Hello World
基于阿里egg框架搭建博客（3）——注册与登录
基于阿里egg框架搭建博客（4）——权限控制
基于阿里egg框架搭建博客（5）——置顶导航条
基于阿里egg框架搭建博客（6）——浏览、发表文章
基于阿里egg框架搭建博客（7）——编辑文章

git

https://github.com/ZzzSimon/egg-example
喜欢就点个赞吧！

正文

俗话说万事开头难，此章节涉及大量的知识点，在每个代码后面都有解释，需要大家查看官方文档。

user表设计

简单来说，注册与登录就是对user表的读写。所以我们首先对user表进行设计：


字段说明

字段 解释
id uuid
username 用户名
password 密码
phone 手机号
create_time 创建时间
update_time 更新时间
avatar_url 头像url

sql脚本

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` varchar(20) NOT NULL,
  `username` varchar(18) NOT NULL,
  `password` varchar(20) NOT NULL,
  `phone` varchar(11) DEFAULT NULL,
  `create_time` datetime NOT NULL,
  `update_time` datetime NOT NULL,
  `avatar_url` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`username`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

注册

页面设计


页面设计如上图所示，需要用户输入用户名，密码，手机号，还可以上传自己的头像。

前端代码

官方文档推荐我们使用nunjucks作为模板。

使用方法：https://eggjs.org/zh-cn/intro/quickstart.html#%E6%A8%A1%E6%9D%BF%E6%B8%B2%E6%9F%93

我们在app\view\home目录下创建register.tpl文件：

<html>
<head>
    <title>注册</title>
    <link rel="stylesheet" href="/public/bootstrap/css/bootstrap.css">
    <script type="text/javascript" src="/public/js/jquery.min.js"></script>
    <script type="text/javascript" src="/public/bootstrap/js/bootstrap.min.js"></script>
</head>
<body>
<div class="container ">
    <form class="center-block" style="width: 50%;margin-top: 10%"
          method="POST" action="/user/register?_csrf={{ ctx.csrf | safe }}" enctype="multipart/form-data">
        <div class="form-group ">
            <img src="/public/avatar/default.jpg" id="avatarPic" class="img-circle center-block" style="width: 64px;">
            <input type="file" id="avatarBtn" name="file" style="visibility: hidden">
            <p class="text-center help-block">点击头像更改，只支持jpg,png格式，大小≤ 200 kb</p>
        </div>
        <div class="form-group">
            <label for="username">账号</label>
            <input type="text" class="form-control" id="username" placeholder="用户名" name="username">
        </div>
        <div class="form-group">
            <label for="password">密码</label>
            <input type="password" class="form-control" id="password" placeholder="密码" name="password">
        </div>
        <div class="form-group">
            <label for="phone">手机号</label>
            <input type="text" class="form-control" id="phone" placeholder="手机号" name="phone">
        </div>
        <div class="form-group">
            <button type="submit" class="btn btn-info pull-right">注册</button>
        </div>
    </form>
</div>
<script>
    $('#avatarPic').bind('click', function () {
        $('#avatarBtn').click();
    });
    $('#avatarBtn').bind('change',function (e) {
        if (window.FileReader) {
            var reader = new FileReader();
            reader.readAsDataURL(e.target.files[0]);
            //监听文件读取结束后事件
            reader.onloadend = function (e) {
                $('#avatarPic').attr("src",e.target.result);    //e.target.result就是最后的路径地址
            };
        }
    });
</script>
</body>
</html>

有3点需要注意：

  1. 静态文件的引用路径/public

官方文档：https://eggjs.org/zh-cn/intro/quickstart.html#%E9%9D%99%E6%80%81%E8%B5%84%E6%BA%90

bootstrap自行搜索并下载，也可以用cdn。

  1. form表单请求url中的?_csrf={{ ctx.csrf | safe }}部分

官方文档：https://eggjs.org/zh-cn/core/security.html#%E5%AE%89%E5%85%A8%E5%A8%81%E8%83%81-csrf-%E7%9A%84%E9%98%B2%E8%8C%83

  1. 最后一段js代码的作用：
    由于bootstrap没有input type=file标签样式，原版实在丑的不行，于是我把原版的隐藏了，在头像图片的点击事件监听里面，手动触发input type=file文件上传按钮的click事件。
    然后当用户选完头像后，通过window.FileReader实时把图片显示出来。

后端代码

HomeController

我们在app\controller\目录下创建home.js文件：
该controller主要返回主页、登录页、注册页等基础页面。

const Controller = require('egg').Controller;

class HomeController extends Controller {
    async register(){
        await this.ctx.render('home/register.tpl')
    }
}
module.exports = HomeController;

UserController

我们在app\controller\目录下创建user.js文件：

//app/controller/user.js
const Controller = require('egg').Controller;
const fs = require('mz/fs');

class UserController extends Controller{
    async register(){
        const ctx = this.ctx;
        const { username, password, phone } = ctx.request.body;
        const avatar = ctx.request.files[0];
        //默认头像
        let filepathNew = this.config.baseDir+'\\app\\public\\avatar\\default.jpg';
        //如果用户上传了头像
        if (avatar) {
            console.log('file:%j', avatar);
            let filenameNew = ctx.helper.uuid() +'.'+  avatar.filename.split('.').pop();
            filepathNew = this.config.baseDir+'\\app\\public\\avatar\\'+filenameNew;
            //把临时文件剪切到新目录去
            await fs.rename(avatar.filepath, filepathNew);
        }

        const nowTime = new Date();
        const userNew = {
            id : ctx.helper.uuid(),
            username : username,
            password : password,
            phone : phone,
            avatar_url : filepathNew.split("\\app")[1],
            create_time : nowTime,
            update_time : nowTime
        };
        const flag = await ctx.service.user.save(userNew);
        if (flag){
            // 设置 Session
            ctx.session.user = {username:username};
            ctx.cookies.set('avatarUrl',userNew.avatar_url,{httpOnly:false});
            ctx.body = {
                successFlag:'Y',
                errorMsg:'登录成功！'
            };
            ctx.redirect('/')
        }else {
            ctx.body = {
                successFlag:'N',
                errorMsg:'用户名已存在！'
            }
        }
    }
}

module.exports = UserController;

有4点需要注意：

  1. controller获取上传的文件

官方文档：https://eggjs.org/zh-cn/basics/controller.html#%E8%8E%B7%E5%8F%96%E4%B8%8A%E4%BC%A0%E7%9A%84%E6%96%87%E4%BB%B6

  1. cookie与session

官方文档：https://eggjs.org/zh-cn/core/cookie-and-session.html

  1. 重定向

官方文档：https://eggjs.org/zh-cn/basics/controller.html#%E9%87%8D%E5%AE%9A%E5%90%91

  1. uuid工具类，helper的使用

官方文档：https://eggjs.org/zh-cn/basics/objects.html#helper

附上我自己实现的uuid生成方法：

moment组件请自行npm安装，官方：http://momentjs.cn/

const moment = require('moment');

//uuid格式：年月日时分秒3位毫秒+3位随机数，共20位  ===>   20190312162455043167
exports.uuid = function uuid() {
    let uuid = moment().format("YYYYMMDDHHmmssSSS");
    uuid += (Array(3).join(0) + Math.random()*100).slice(-3);
    return uuid;
};

UserService

我们在app\service\目录下创建user.js文件：

const Service = require('egg').Service;

class UserService extends Service {
    async save(user){
        const userQ =await this.app.mysql.get('user', {username : user.username});
        if (userQ){
            return false
        }else {
            const result =await this.app.mysql.insert('user', user);
            // 判断插入成功
            const insertSuccess = result.affectedRows === 1;
            if (insertSuccess) {
                return true
            }
        }
        return false
    }
}
module.exports = UserService;

有1点需要注意：

  1. mysql的使用

官方文档：https://eggjs.org/zh-cn/tutorials/mysql.html

router.js

我们在app\目录下的router.js文件中添加以下内容：

module.exports = app => {
    const { router, controller } = app;

    //页面
    router.get('/register.htm', controller.home.register);

    //接口
    router.post('/user/register',controller.user.register);
};

登录

页面设计

前端代码

我们在app\view\home目录下创建login.tpl文件：

<html>
<head>
    <title>登录</title>
    <link rel="stylesheet" href="/public/bootstrap/css/bootstrap.css">
    <script type="text/javascript" src="/public/js/jquery.min.js"></script>
    <script type="text/javascript" src="/public/bootstrap/js/bootstrap.min.js"></script>
</head>
<body>
<div class="container ">
    <form class="center-block" style="width: 50%;margin-top: 20%"
          method="POST" action="/user/login?_csrf={{ ctx.csrf | safe }}" enctype="application/x-www-form-urlencoded">
        <div class="form-group">
            <label for="username">账号</label>
            <input type="text" class="form-control" id="username" placeholder="用户名" name="username">
        </div>
        <div class="form-group">
            <label for="password">密码</label>
            <input type="password" class="form-control" id="password" placeholder="密码" name="password">
        </div>
        <div class="checkbox">
            <label>
                <input type="checkbox" name="rememberMe">记住登录状态
            </label>
        </div>
        <div class="form-group">
            <button type="submit" class="btn btn-info pull-right">登录</button>
            <div>
                <a href="/register.htm" class="btn btn-link pull-right">注册</a>
            </div>
        </div>
    </form>
</div>
</body>
</html>

后端代码

HomeController

我们在app\controller\home.js文件中添加以下内容：

    async login(){
        await this.ctx.render('home/login.tpl');
    }

UserController

我们在app\controller\user.js文件中添加以下内容：

    async login(){
        const ctx = this.ctx;
        ctx.logger.info('req body:: %j',ctx.request.body);
        const { username, password, rememberMe } = ctx.request.body;
        const user = await ctx.service.user.loginAndGetUser(username, password);
        if (!user){
            ctx.body = {
                successFlag:'N',
                errorMsg:'用户名或密码错误！'
            }
        }else {
            // 设置 Session
            ctx.session.user = {username:user.username};
            ctx.cookies.set('avatarUrl',user.avatar_url,{httpOnly:false});
            // 如果用户勾选了 `记住我`，设置 的过期时间
            if (rememberMe) ctx.session.maxAge = this.config.rememberMe;
            ctx.body = {
                successFlag:'Y',
                errorMsg:'登录成功！'
            };
            ctx.redirect('/')
        }
    }

有1点需要注意：

  1. 用户勾选'记住我'后的session过期时间读取了配置文件中的值。配置：

官方文档：https://eggjs.org/zh-cn/basics/config.html

UserService

我们在app\service\user.js文件中添加以下内容：

    async loginAndGetUser(username, password) {
        const user =await this.app.mysql.get('user', {username : username});
        if (!user || user.password !== password){
            return false
        } else {
            return user;
        }
    }

router.js

我们在app\router.js文件中添加以下内容：

    router.get('/login.htm',controller.home.login);
    router.post('/user/login',controller.user.login);

配置文件参考

config.default.js

参考官方文档后，你的配置文件应该如下（object 对象写法）：

const path = require('path');
module.exports = appInfo => {
    return {
        keys: "123456",
        rememberMe : 24 * 60 * 60 * 1000, //选择记住我之后，session有效时长
        security : {
            domainWhiteList:['.127.0.0.1'],  // 安全白名单，以 . 开头
        },
        multipart : {
            mode: 'file',
            tmpdir: path.join(appInfo.baseDir, 'app/public/temp'),
        },
        session : {
            key: 'EGG_SESS',
            maxAge: 10 * 1000, // 单位毫秒
            httpOnly: true,
            encrypt: true,
        },
        view : {
            defaultViewEngine: 'nunjucks',
            mapping: {
                '.tpl': 'nunjucks',
            },
        },
        mysql : {
            // 单数据库信息配置
            client: {
                // host
                host: 'localhost',
                // 端口号
                port: '3306',
                // 用户名
                user: '数据库账号',
                // 密码
                password: '数据库密码',
                // 数据库名
                database: '你的数据库名',
            },
            // 是否加载到 app 上，默认开启
            app: true,
            // 是否加载到 agent 上，默认关闭
            agent: false,
        },
    };
};

plugin.js

exports.nunjucks = {
    enable: true,
    package: 'egg-view-nunjucks'
};

exports.mysql = {
    enable: true,
    package: 'egg-mysql',
};

结尾

如果看完觉得有用，请给作者一个喜欢吧！谢谢啦！

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 214,837评论 6赞 496
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 91,551评论 3赞 389
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 160,417评论 0赞 350
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 57,448评论 1赞 288
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,524评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,554评论 1赞 293
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,569评论 3赞 414
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,316评论 0赞 270
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,766评论 1赞 307
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,077评论 2赞 330
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,240评论 1赞 343
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,912评论 5赞 338
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,560评论 3赞 322
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,176评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,425评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,114评论 2赞 366
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,114评论 2赞 352