egg

Author: csxiaoyaojianxian

17-nodejs/02-egg/.autod.conf.js

@@ -0,0 +1,28 @@
+'use strict';
+
+module.exports = {
+  write: true,
+  plugin: 'autod-egg',
+  prefix: '^',
+  devprefix: '^',
+  exclude: [
+    'test/fixtures',
+    'coverage',
+  ],
+  dep: [
+    'egg',
+    'egg-scripts',
+  ],
+  devdep: [
+    'autod',
+    'autod-egg',
+    'egg-bin',
+    'tslib',
+    'typescript',
+  ],
+  keep: [
+  ],
+  semver: [
+  ],
+  test: 'scripts',
+};

17-nodejs/02-egg/.eslintignore

@@ -0,0 +1,2 @@
+**/*.d.ts
+node_modules/

17-nodejs/02-egg/.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "eslint-config-egg/typescript",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  }
+}

17-nodejs/02-egg/.github/workflows/nodejs.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        node-version: [8.x]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm i -g npminstall && npminstall
+    - run: npm run ci
+      env:
+        CI: true

17-nodejs/02-egg/.gitignore

@@ -0,0 +1,20 @@
+logs/
+npm-debug.log
+node_modules/
+coverage/
+.idea/
+run/
+logs/
+.DS_Store
+.vscode
+*.swp
+*.lock
+*.js
+!.autod.conf.js
+
+app/**/*.js
+test/**/*.js
+config/**/*.js
+app/**/*.map
+test/**/*.map
+config/**/*.map

17-nodejs/02-egg/.travis.yml

@@ -0,0 +1,12 @@
+
+language: node_js
+node_js:
+  - '8'
+before_install:
+  - npm i npminstall -g
+install:
+  - npminstall
+script:
+  - npm run ci
+after_script:
+  - npminstall codecov && codecov

17-nodejs/02-egg/README.md

@@ -0,0 +1,33 @@
+# hackernews-async-ts
+
+[Hacker News](https://news.ycombinator.com/) showcase using typescript && egg
+
+## QuickStart
+
+### Development
+
+```bash
+$ npm i
+$ npm run dev
+$ open http://localhost:7001/
+```
+
+Don't tsc compile at development mode, if you had run `tsc` then you need to `npm run clean` before `npm run dev`.
+
+### Deploy
+
+```bash
+$ npm run tsc
+$ npm start
+```
+
+### Npm Scripts
+
+- Use `npm run lint` to check code style
+- Use `npm test` to run unit test
+- se `npm run clean` to clean compiled js at development mode once
+
+### Requirement
+
+- Node.js 8.x
+- Typescript 2.8+

17-nodejs/02-egg/app.ts

@@ -0,0 +1,60 @@
+class AppBootHook {
+  private app;
+  constructor(app) {
+    this.app = app;
+  }
+
+  configWillLoad() {
+    // 此时 config 文件已经被读取并合并，但是还并未生效
+    // 这是应用层修改配置的最后时机
+    // 注意：此函数只支持同步调用
+
+    // 例如：参数中的密码是加密的，在此处进行解密
+    // this.app.config.mysql.password = decrypt(this.app.config.mysql.password);
+    // 例如：插入一个中间件到框架的 coreMiddleware 之间
+    // const statusIdx = this.app.config.coreMiddleware.indexOf('status');
+    // this.app.config.coreMiddleware.splice(statusIdx + 1, 0, 'limit');
+  }
+
+  async didLoad() {
+    // 所有的配置已经加载完毕
+    // 可以用来加载应用自定义的文件，启动自定义的服务
+
+    // 例如：创建自定义应用的示例
+    // this.app.queue = new Queue(this.app.config.queue);
+    // await this.app.queue.init();
+
+    // 例如：加载自定义的目录
+    // this.app.loader.loadToContext(path.join(__dirname, 'app/tasks'), 'tasks', {
+    //   fieldClass: 'tasksClasses',
+    // });
+  }
+
+  async willReady() {
+    // 所有的插件都已启动完毕，但是应用整体还未 ready
+    // 可以做一些数据初始化等操作，这些操作成功才会启动应用
+
+    // 例如：从数据库加载数据到内存缓存
+    // this.app.cacheData = await this.app.model.query(QUERY_CACHE_SQL);
+  }
+
+  async didReady() {
+    // 应用已经启动完毕
+
+    // const ctx = await this.app.createAnonymousContext();
+    // await ctx.service.Biz.request();
+  }
+
+  async serverDidReady() {
+    console.log('app start');
+    // http / https server 已启动，开始接受外部请求
+    // 此时可以从 app.server 拿到 server 的实例
+
+    this.app.server.on('timeout', socket => {
+      // handle socket timeout
+      console.log(socket.connecting);
+    });
+  }
+}
+
+export default AppBootHook;

17-nodejs/02-egg/app/controller/index.ts

@@ -0,0 +1,12 @@
+import { Controller } from 'egg';
+
+export default class HomeController extends Controller {
+  public async index() {
+    const { ctx } = this;
+    ctx.body = await ctx.service.test.sayHi('egg');
+  }
+  public async notFound() {
+    const { ctx } = this;
+    ctx.body = '404~~~~';
+  }
+}

17-nodejs/02-egg/app/controller/topics.ts

@@ -0,0 +1,49 @@
+import { Controller } from 'egg';
+
+// 定义创建接口的请求参数规则
+// https://github.com/node-modules/parameter#rule
+const createRule = {
+  name: 'string',
+  type: { type: 'enum', values: [ 'ask', 'share' ], required: false },
+};
+
+export default class TopicController extends Controller {
+  // GET	/topics	topics
+  public async index() {
+    const { ctx } = this;
+    ctx.body = ctx.app.env; // local
+    ctx.response.type = 'application/json';
+    ctx.status = 200;
+  }
+
+  // GET	/topics/new	new_topic
+  public async new() {
+    const { app, ctx } = this;
+    ctx.throw({
+      code: app.config.CODE.TEST_ERROR,
+      message: '测试错误抛出',
+    });
+  }
+
+  // POST	/topics	topics
+  public async create() {
+    const { ctx } = this;
+    // 校验 `ctx.request.body` 是否符合我们预期的格式
+    // 如果参数校验未通过，将会抛出一个 status = 422 的异常
+    ctx.validate(createRule, ctx.request.body);
+    // 调用 service 创建一个 topic
+    const data = await ctx.service.topics.create(ctx.request.body);
+    // 设置响应体和状态码
+    ctx.helper.rest({
+      ...data
+    }, 'ok', 0);
+  }
+  // GET	/topics/:id	topic
+  public async show() {}
+  // GET	/topics/:id/edit	edit_topic
+  public async edit() {}
+  // PUT	/topics/:id	topic
+  public async update() {}
+  // DELETE	/topics/:id	topic
+  public async destroy() {}
+}

17-nodejs/02-egg/app/extend/helper.ts

@@ -0,0 +1,19 @@
+/**
+ * @name: rest.js
+ * @desc: restful middleware
+ * @author: [email protected]
+ * @date: 2020.07.13
+ */
+import { IHelper } from 'egg';
+
+export default {
+  async rest(this: IHelper, data = {}, message = 'success', code = 0) {
+    const { ctx } = this;
+    ctx.response.type = 'application/json';
+    ctx.response.body = {
+      code,
+      message,
+      data,
+    };
+  }
+};

17-nodejs/02-egg/app/middleware/errorHandler.ts

@@ -0,0 +1,39 @@
+export default () => {
+  return async function errorHandler(ctx, next) {
+    try {
+      await next();
+    } catch (err) {
+      // 所有的异常都在 app 上触发一个 error 事件，框架会记录一条错误日志
+      ctx.app.emit('error', err, ctx);
+
+      const status = err.status || 500;
+      // 生产环境时 500 错误的详细错误内容不返回给客户端，因为可能包含敏感信息
+      const error = status === 500 && ctx.app.config.env === 'prod'
+        ? 'Internal Server Error'
+        : err.message;
+
+      // 从 error 对象上读出各个属性，设置到响应中
+      ctx.body = {
+        code: parseInt(err.code) || -1,
+        message: error,
+      };
+      switch (status) {
+        // 参数校验未通过
+        case 422:
+          ctx.body.detail = err.errors;
+          break;
+      }
+      ctx.status = status;
+    }
+
+    // 404 单独处理
+    if (ctx.status === 404 && !ctx.body) {
+      console.log(ctx.acceptJSON)
+      if (ctx.acceptJSON) {
+        ctx.body = { error: 'Not Found' };
+      } else {
+        ctx.body = '<h1>Page Not Found</h1>';
+      }
+    }
+  };
+};

17-nodejs/02-egg/app/middleware/robot.ts

@@ -0,0 +1,16 @@
+
+
+// options === app.config.robot
+export default (options, app) => {
+  console.log(app.config.robot);
+  return async function robotMiddleware(ctx, next) {
+    const source = ctx.get('user-agent') || '';
+    const match = options.ua.some(ua => ua.test(source));
+    if (match) {
+      ctx.status = 403;
+      ctx.message = 'Go away, robot.';
+    } else {
+      await next();
+    }
+  }
+};

17-nodejs/02-egg/app/public/test.html

@@ -0,0 +1 @@
+<h1>test html</h1>

17-nodejs/02-egg/app/router.ts

@@ -0,0 +1,10 @@
+import { Application } from 'egg';
+
+export default (app: Application) => {
+  const { controller, router } = app;
+
+  router.get('/', controller.index.index);
+  router.resources('topics', '/api/topics', app.controller.topics);
+  router.get('*', controller.index.notFound);
+
+};

17-nodejs/02-egg/app/service/Test.ts

@@ -0,0 +1,15 @@
+import { Service } from 'egg';
+
+/**
+ * Test Service
+ */
+export default class Test extends Service {
+
+  /**
+   * sayHi to you
+   * @param name - your name
+   */
+  public async sayHi(name: string) {
+    return `hi, ${name}`;
+  }
+}

17-nodejs/02-egg/app/service/topics.ts

@@ -0,0 +1,11 @@
+import { Service } from 'egg';
+
+export default class TopicService extends Service {
+  constructor(ctx) {
+    super(ctx);
+  }
+
+  public async create(params) {
+    return params;
+  }
+}

17-nodejs/02-egg/appveyor.yml

@@ -0,0 +1,14 @@
+environment:
+  matrix:
+    - nodejs_version: '8'
+
+install:
+  - ps: Install-Product node $env:nodejs_version
+  - npm i npminstall && node_modules\.bin\npminstall
+
+test_script:
+  - node --version
+  - npm --version
+  - npm run test
+
+build: off