Egg.js构建可复用页面：基类的创建与公共路径的配置

前端

2023-12-24 02:03:53

对于任何后端开发框架而言，代码可重用性都是至关重要的。在Egg.js框架中，基类是一个关键概念，它允许开发者创建可复用且可扩展的代码。

创建基类：实现代码复用

为什么要创建基类？

基类提供以下优势：

避免重复代码：将公共代码提取到基类中，避免在多个控制器中重复编写。
维护性增强：更新基类可以同时更新所有继承它的控制器，简化维护。
提高可扩展性：基类为添加新功能和扩展现有功能提供了灵活的机制。

实现方法

在Egg.js中，可以在 app/controller/base 下创建 base.js 文件来定义基类。

// app/controller/base.js
module.exports = app => {
  class BaseController extends app.Controller {
    async index() {
      // 基类控制器方法
    }
  }
  return BaseController;
};

配置公共页面：灵活管理URL

Egg.js允许开发者通过 app/router.js 文件配置公共页面，例如网站首页或关于页面。

配置方法

// app/router.js
module.exports = app => {
  const { router } = app;
  router.get('/', 'home.index');
  router.get('/about', 'about.index');
};

配置后台地址：轻松管理后台操作

Egg.js提供了一个默认的后台地址 /admin，开发者可以自定义后台地址以提高安全性。

配置方法

在 config/config.default.js 文件中，添加以下配置：

// config/config.default.js
module.exports = {
  // ...其他配置
  admin: {
    // 自定义后台地址
    admin_prefix: '/myAdmin'
  }
};

配置退出登录：安全退出管理

Egg.js提供了方便的 logout 方法，用于安全退出登录。

配置方法

在 config/config.default.js 文件中，添加以下配置：

// config/config.default.js
module.exports = {
  // ...其他配置
  security: {
    // 退出登录地址
    logoutURL: '/logout'
  }
};

实践与应用

使用基类

在其他控制器中，可以通过 extend 继承基类。例如：

// app/controller/home.js
module.exports = app => {
  class HomeController extends app.Controller {
    // HomeController特有方法
  }
  return HomeController;
};

配置公共页面

在浏览器中输入 / 和 /about URL，可以访问配置的首页和关于页面。

自定义后台地址

在浏览器中输入自定义的后台地址 /myAdmin，可以访问后台管理界面。

退出登录

在浏览器中访问配置的退出登录地址 /logout，可以安全退出登录状态。