蛋壳框架蛋学习指南：从入门到实战的egg.js课程

蛋壳框架（egg.js）是基于Node.js的高性能Web应用框架，旨在简化Web开发流程，提供一套高效且灵活的组件和工具，帮助开发者快速搭建功能丰富的Web应用。本文将带你从蛋壳框架的基本概念开始，逐步深入学习如何安装和配置开发环境，理解其核心模块，实战构建一个简单的应用，并掌握自定义中间件和数据库操作等高级特性。

安装Node.js

首先，确保你的系统已安装最新版本的Node.js。访问Node.js官网下载并安装适用于你操作系统的最新版本。

安装egg.js

使用npm或Yarn初始化egg.js项目：

# 使用npm
npm install -g egg-init
egg init your-project-name
cd your-project-name

# 使用Yarn
yarn add egg

配置开发环境

• 目录结构：默认的egg.js项目结构./app目录用于存放各种模块，每个模块下又有controller, service, middleware, config等子目录。

• 配置文件：app/config/config.default.js用于存放默认配置项，app/config/config.prod.js和app/config/config.dev.js分别用于生产环境和开发环境的配置。

// app/config/config.default.js
exports.someConfig = 'default value';

启动项目

# 开发环境
npm run dev

# 生产环境
npm run start

路由配置

// app/router.js
const router = require('egg').router;

exports.routes = router([
  { method: 'GET', path: '/', handler: 'index.index' },
  { method: 'POST', path: '/users', handler: 'users.create' },
]);

控制器实现

// app/controller/index.js
module.exports = app => {
  const { ctx } = app;

  ctx.get('/hello', async (ctx) => {
    let message = 'Hello, World!';
    ctx.body = message;
  });

  ctx.post('/users', async (ctx) => {
    // 假设用户服务创建用户
    let userId = await ctx.service.users.create(ctx.request.body);
    ctx.body = { userId };
  });
};

中间件扩展

// app/middleware/logger.js
module.exports = function* (next) {
  console.log('中间件日志：请求开始');
  yield next;
  console.log('中间件日志：请求结束');
};

// app/plugin/logger.js
exports.config = {
  enabled: true,
};

应用创建

egg init simple-app
cd simple-app

添加路由、控制器和中间件

// app/router.js
exports.routes = router([
  { method: 'GET', path: '/hello', handler: 'hello.index' },
  { method: 'POST', path: '/users', handler: 'users.create' },
]);

// app/controller/hello.js
module.exports = app => {
  const { ctx } = app;

  ctx.get('/index', async (ctx) => {
    return ctx.body = 'Hello, Egg!';
  });

  ctx.post('/create', async (ctx) => {
    const userId = await ctx.service.users.create(ctx.request.body);
    return ctx.body = { userId };
  });
};

// app/service/users.js
module.exports = app => {
  const { ctx } = app;

  ctx.service.users = {
    create: async (data) => {
      const userId = Date.now();
      return userId;
    },
  };
};

启动并访问应用

npm run dev

访问http://localhost:7001/hello和http://localhost:7001/users，你可以看到应用的响应。

自定义中间件

// app/middleware/customLogger.js
module.exports = function* (next) {
  console.log('自定义中间件日志：请求开始');
  yield next;
  console.log('自定义中间件日志：请求结束');
};

使用中间件

// app/router.js
exports.middleware = [
  'customLogger',
];

服务集成

// app/service/user.js
module.exports = app => {
  const { ctx } = app;

  ctx.service.user = {
    // 省略具体实现
  };
};

数据库连接与操作

假设使用Sequelize作为ORM：

// app/database.js
const Sequelize = require('sequelize');
const config = require('../config/config.default');

const sequelize = new Sequelize(config.database, config.username, config.password, {
  host: config.host,
  dialect: 'mysql',
});

module.exports = sequelize;

// app/service/user.js
const { User } = require('../database');

module.exports = app => {
  const { ctx } = app;

  ctx.service.user = {
    async findById(userId) {
      return User.findByPk(userId);
    },
  };
};

模板使用

蛋壳框架默认使用了模板引擎，如EJS、Nunjucks等。配置模板引擎：

// app/config/config.default.js
exports.view = {
  defaultViewEngine: 'nunjucks',
  mapping: {
    '.': path.join(appRoot, 'views'),
  },
};

通过上述实践，你已经初步了解了蛋壳框架的使用方法，从环境搭建到基础配置，再到路由、控制器、中间件、服务与数据库操作的实战案例。蛋壳框架以其简洁的API和强大的功能支持，为Web开发者提供了一条高效构建Web应用的路径。继续深入探索实践，你将能构建出更加复杂且性能优化的Web应用。