Egg 中的控制器继承与兼容

越陌度阡

发布于 2020-11-26 10:40:35

7420

发布于 2020-11-26 10:40:35

文章被收录于专栏：大前端（横向跨端 & 纵向全栈）

1. 控制器的继承

项目中多个控制器使用公共的方法时，可以将这些方法写在一个基类控制器中，其它的控制器全部继承于这个基类控制器，这样基类中的方法就可以在其它的控制器中使用了。

定义基类控制器。

// app/core/base.js
'use strict';
const Controller = require('egg').Controller;
// 所有控制器的基类
class BaseController extends Controller {
    // 全局的获取用户信息方法
    async getUserInfo() {
        // 模拟数据
        return {
            name: '张三',
            age: 20
        }
    }
    // 全局的请求成功跳转,成功后跳转到首页
    async success(redirectUrl) {
        // 渲染成功提示页面
        await this.ctx.render('public/success', {
            // 指定成功提示页面3秒后的跳转地址
            redirectUrl: redirectUrl || '/index'
        });
    }
    // 全局的请求失败跳转，失败后进入登录页
    async error(redirectUrl) {
        // 渲染失败提示页面
        await this.ctx.render('public/error', {
            // 指定失败提示页面3秒后的跳转地址
            redirectUrl: redirectUrl || '/login'
        });

    }
}

module.exports = BaseController;

定义子类控制器，继承于基类控制器。

// app/controller/user.js
'use strict';
const BaseController = require('../core/base.js');
// 其它控制器继承基类控制器
class UserController extends BaseController {
    // 登录页面
    async login() {
        await this.ctx.render('login');
    }
    // 注册页面
    async register() {
        await this.ctx.render('register');
    }
    // 提交登录信息
    async doLogin() {
        // 调用基类控制器中的方法
        await this.success('/index');
    }
    // 提交注册信息
    async doRegister() {
        // 调用基类控制器中的方法
        await this.error('/login');
    }
}

module.exports = UserController;

定义基类控制器中需要渲染的公共模板文件success.html。

<!-- /app/view/public/success.html -->
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <!-- 3秒后自动跳转 -->
    <meta http-equiv="refresh" content="3;url=<%=redirectUrl%>"> 
</head>
<body>
    <h1 style="font-size: 60px;">
        请求成功! 3秒后自动跳转。。。
    </h1>
</body>
</html>

定义基类控制器中需要渲染的公共模板文件error.html。

<!-- /app/view/public/error.html -->
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <!-- 3秒后自动跳转 -->
    <meta http-equiv="refresh" content="3;url=<%=redirectUrl%>"> 
    
</head>
<body>
    <h1 style="font-size: 60px; color:red;">
        请求失败!3秒后自动跳转。。。
    </h1>
</body>
</html>

2. 控制器的兼容写法

// app/controller/home.js
'use strict';
const Controller = require('egg').Controller;
class HomeController extends Controller {
    // 控制器兼容写法，ctx通过传参获取
    // 不推荐使用，只是为了兼容
    async index(ctx) {      
        await ctx.render('index');
    }
    // 正常的写法，ctx通过this调用
    async login() {      
        await this.ctx.render('login');
    }
}

module.exports = HomeController;

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2020/03/27 ，如有侵权请联系 cloudcommunity@tencent.com 删除

html