Express Annotate JS 
Express Annotate JS 是一个基于 Javascript 中的注解提案 proposal-decorators 和 Express 而实现的一套快速开发的 NodeJS 框架，其注解模块核心基于 Annotate JS
使用条件及环境
- 依赖项目
"@palerock/annotate-js": "^1.2.26""express": "^4.17.1"
- 使用前提
- 熟悉 ES6 或以上的 Javascript 语法
- 需要对 NodeJS 服务端开发有一定了解
- 需要对 express 框架有一定了解
- 需要了解
proposal-decorators提案以及如何通过 babel 来搭建开发环境 - 需要了解 Annotate JS 该框架的基本注解用法
快速开始
引入
# 引入依赖
npm install express@4.17.1
npm install @palerock/annotate-js
# 引入 express-annotate-js
npm install @palerock/express-annotate-js以及一个简单的能够使用 proposal-decorators 提案的开发环境
{
"presets": [
[
"@babel/preset-env"
]
],
"plugins": [
[
"@babel/plugin-proposal-decorators",
{
"legacy": true
}
],
[
"@babel/plugin-proposal-class-properties",
{
"loose": true
}
]
]
}使用
import {launcher, GetMapping, Register} from "@palerock/express-annotate-js";
import {Boot, Autowired, Bean} from "@palerock/annotate-js";
@Register // 将该 class 注册为 web 服务
class DemoController {
@Autowired
DemoService; // 自动注入 Service
@GetMapping({url: '/'})
getContent({content}) {
// 通过参数注入获取请求参数
return `Hello Express Annotate JS, ${this.DemoService.parseContent(content)}`;
}
}
@Bean
class DemoService {
parseContent(content) {
return `Parsed content: ${content}`;
}
}
@Boot
class Application {
port = 3034;
main() {
// 启动服务
launcher.start(this.port);
}
}运行后在浏览器输入以下链接 http://localhost:3034/?content=Enjoy%20it
将会看到显示如下内容： "Hello Express Annotate JS, Parsed content: Enjoy it"
使用异步方法
Express Annotate JS 同样支持异步，实例如下：
import {launcher, GetMapping, Register} from "@palerock/express-annotate-js";
import {Boot, Autowired, Bean, EnergyWire} from "@palerock/annotate-js";
@Register
class AsyncController {
@Autowired // 注入 APIService
APIService;
@GetMapping({url: '/project/:id'}) // 使用 :id 将 URL 中的 id 映射为参数并注入到方法中
async getProject({id}) {
return this.APIService.getProjectCache(id);
}
}
@Bean
class APIService {
// 注入 Utils 中的 wait 方法
@EnergyWire('Utils')
wait;
// 缓存用于返回
projectCacheMap = {
'1': {
name: 'Project 01'
},
'2': {
name: 'project 02'
}
};
async getProjectCache(id) {
await this.wait(2000); // 等待 2s
if (id in this.projectCacheMap) {
return this.projectCacheMap[id];
}
return null;
}
}
@Bean
class Utils {
async wait(ms) {
return new Promise(resolve => {
setTimeout(() => resolve(), ms);
})
}
}
@Boot
class Application {
port = 3034;
main() {
launcher.start(this.port);
}
}启动服务后，浏览器输入 http://localhost:3034/project/1，可以在等待 2s 后看到返回结果：
{"name":"Project 01"}如上诉例子所见，只需要对指定方法加上
async/await关键字便可以支持异步方法
于此同时，因为使用的是 Express，所以 URL 的书写方式和 Express 表达一致，/project/:id表示 RESTFul 规范中 GET 方法中获取资源的映射规则。