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/
推薦學習:《node.js影片教學》
以上是egg.js是node麼的詳細內容。更多資訊請關注PHP中文網其他相關文章!