egg.js是node麼 - tw511教學網

egg.js是node框架，是一個繼承於Koa的node.js框架；egg.js框架不同於exporess、koa等基礎框架，egg.js在應用級的提煉封裝，使其更貼近業務場景，更快上手。

本教學操作環境：Windows10系統、egg.js v2.0.0版、Dell G3電腦。

egg.js是node麼？

是。

瞭解 egg.js

Egg 是一個繼承於 Koa 的 node.js 框架。不同於 exporess、koa 等基礎框架，egg.js 在應用級的提煉封裝，使其更貼近業務場景，更快上手。

Egg 按照約定進行開發，奉行『約定優於設定』，團隊共同作業成本低

安裝

npm init egg
npm i
npm run dev
登入後複製

一個基礎的 API 大致由路由、獲取請求引數、邏輯處理、返回響應資料幾部分組成

路由

app/router.js 用於設定 URL 路由規則

router.get("/", controller.home.index);
// 當存取GET '/' ，app/controller/home.js 下的 index 方法會執行
router.post("/create", controller.user.create);
// 當存取POST '/create' ，app/controller/user.js 下的 create 方法會執行
登入後複製

獲取請求引數

this.ctx.query獲取 URL 中 ? 後面的部分引數

// GET /posts?category=egg&language=node
// app/controller/post.js
class PostController extends Controller {
  async listPosts() {
    const query = this.ctx.query;
    // {
    //   category: 'egg',
    //   language: 'node',
    // }
  }
}
登入後複製

this.ctx.params獲取路由中的動態引數

// app.get('/projects/:projectId/app/:appId', controller.app.listApp);
// GET /projects/1/app/2
class AppController extends Controller {
  async listApp() {
    const params = this.ctx.params;
    // {
    //   projectId: '1',
    //   appId: '2'
    // }
  }
}
登入後複製

this.ctx.request.body獲取 body 引數

// POST /api/posts HTTP/1.1
// Host: localhost:3000
// Content-Type: application/json; charset=UTF-8
//
// {"title": "controller", "content": "what is controller"}
class PostController extends Controller {
  async listPosts() {
    const body = this.ctx.request.body;
    // {
    //   title: 'controller',
    //   content: 'what is controller'
    // }
  }
}
登入後複製

返回響應資料

this.ctx.body返回響應資料

class ViewController extends Controller {
  async show() {
    // 返回Content-Type為application/json的body
    this.ctx.body = {
      name: "egg",
      category: "framework",
      language: "Node.js",
    };
  }
  async page() {
    // 返回Content-Type為text/html的body
    this.ctx.body = "<html><h1>Hello</h1></html>";
  }
}
登入後複製

使用 mysql 資料庫

安裝 mysql 外掛

npm i egg-mysql
登入後複製

設定

// config/plugin.js
exports.mysql = {
  enable: true,
  package: "egg-mysql",
};
// config/config.${env}.js
exports.mysql = {
  // 單資料庫資訊設定
  client: {
    // host
    host: "localhost",
    // 埠號
    port: "3306",
    // 使用者名稱
    user: "root",
    // 密碼
    password: "root",
    // 資料庫名
    database: "database",
  },
};
登入後複製

使用

// 查詢id 為 ${uid}的使用者
await this.app.mysql.get("users", { id: uid });
登入後複製

處理業務邏輯

業務邏輯建議放在app/service中，當然也包括資料庫的操作

// app/service/user.js
const Service = require("egg").Service;
class UserService extends Service {
  async find(uid) {
    // 假如 我們拿到使用者 id 從資料庫獲取使用者詳細資訊
    const user = await this.app.mysql.get("users", { id: uid });
    return user;
  }
}
module.exports = UserService;
登入後複製

之後可以通過 Controller 獲取 Service 層拿到的資料。

// app/controller/user.js
class UserController extends Controller {
  async info() {
    const ctx = this.ctx;
    const userId = ctx.params.id;
    // 呼叫service層的user下的find方法
    const user = await ctx.service.user.find(userId);
    ctx.body = user;
  }
}
登入後複製

基本 CURD 語句可以使用 create、get、select、update、delete 方法

直接執行 sql 語句可使用 query 方法

事務的控制

egg.js 官網：https://www.eggjs.org/zh-CN/
登入後複製

推薦學習：《》

以上就是egg.js是node麼的詳細內容，更多請關注TW511.COM其它相關文章！