hanasaki的小窝

Typescript装饰器

2024-10-25T13:20:19.000Z

# 介绍

随着 TypeScript 和 ES6 里引入了类，在一些场景下我们需要额外的特性来支持标注或修改类及其成员。装饰器（Decorators）为我们在类的声明及成员上通过元编程语法添加标注提供了一种方式。 Javascript 里的装饰器目前处在建议征集的第二阶段，但在 TypeScript 里已做为一项实验性特性予以支持。

装饰器是一项实验性特性，在未来的版本中可能会发生改变。

有两种方式启用装饰器特性:

shell:

tsc --target ESNext --experimentalDecrators

tsconfig.json:

	{
	"compilerOptions": {
	"target": "ESNext",
	"experimentalDecorators": true
	}
	}

# 装饰器

装饰器是一种特殊类型的声明，它能够被附加到类声明，方法，访问符，属性或参数上。装饰器使用 @expression 这种形式， expression 求值后必须为一个函数，它会在运行时被调用，被装饰的声明信息做为参数传入。

例如，有一个 @foo 装饰器，我们会这样定义 foo 函数：

	function fool(target: any) {
	// do somthing with 'target'
	}

# 装饰器工厂

装饰器工厂就是一个函数，它返回一个简单的表达式，供装饰器在运行时调用。

function add(value: number) {
    return function(target: any) {
        // do somthing with target
    }
}

# 装饰器求值

类中不同声明上的装饰器将按以下规定的顺序应用：

参数装饰器，然后依次是方法装饰器，访问符装饰器，或属性装饰器应用到每个实例成员。
参数装饰器，然后依次是方法装饰器，访问符装饰器，或属性装饰器应用到每个静态成员。
参数装饰器应用到构造函数。
类装饰器应用到类。<br>

# 类装饰器

类装饰器在类声明之前被声明（紧靠着类声明）。类装饰器应用于类构造函数，可以用来监视，修改或替换类定义。
如果类装饰器返回一个值，它会使用提供的构造函数来替换类的声明。

	interface Greeting {
	hello: string
	}

	function setHello(target: any) {
	target.prototype.hello = "hello" // 为类设置属性
	}

	@sayHello
	class Greeting {
	constructor() ()
	}

	const greeting: Greeting = new Greeting();
	console.log(greeting.hello); // "hello"

# 方法装饰器

方法装饰器声明在一个方法的声明之前（紧靠着方法声明）。它会被应用到方法的属性描述符上，可以用来监视，修改或者替换方法定义。

方法装饰器需传入 3 个参数：

target: any 对于静态成员来说是类的构造函数，对于实例成员是类的原型对象
propertyKey: string | symbol 方法的名称
descriptor: PropertyDescriptor 方法的描述修饰方法

	function onRegister(): MethodDecorator {
	return function (
	target: any,
	propertyKey: string \| symbol,
	descriptor: PropertyDescriptor,
	) {
	console.log(target); // Person: {}
	console.log(propertyKey); // "foo"
	console.log(descriptor); // { "writable": true, "enumerable": false, "configurable": true }
	console.log(descriptor.value); // foo() { console.log('foo'); }
	};
	}

	class Person {
	name: string = "";
	@onRegister()
	foo() {
	console.log("foo");
	}
	}

	const p = new Person();

未完待续……

# 参考文献

[1] Typescript 中文网 | 装饰器

mizuki-sdk

2024-10-23T15:31:50.000Z

# mizuki-sdk

这篇文档先占个位，有空慢慢完善

基于腾讯官方 typescript sdk 的改版 qb-sdk 实现的 NTQQ 接入框架。

⚠️ 本项目由于使用了装饰器特性，只支持使用 typescript 进行开发。

# 安装与使用

# 注册 QQ 开放平台机器人

前往 QQ 开放平台，注册机器人
点击机器人卡片，在开发 > 开发设置里获取 AppID 和 Token

# 安装与配置本项目

在你的项目文件夹中

	# npm
	npm install mizuki-sdk

	# yarn
	yarn add mizuki-sdk

修改 tsconfig.json ，开启装饰器

	{
	"compilerOptions": {
	...
	"experimentalDecorators": true,
	...
	}
	}

# 开始你的第一个 hello world

我们新建一个 main.ts 和一个文件夹 plugins ，并在此文件夹新建一个 index.ts ，和 hello-world.ts

	// main.ts
	import { server, AvailableIntentsEventsEnum } from "mizuki-sdk";
	import "./plugins/index.ts";

	const config = {
	appID: "<your appID>",
	token: "<your token>",
	intents: [AvailableIntentsEventsEnum.GROUP_AND_C2C_EVENT],
	sandbox: true,
	};

	await server.run(config);

	// plugins/index.ts
	export * from "./hello-world";

	// plugins/hello-world.ts
	import { mapper, plugins, GroupContext, MessageType } from "mizuki-sdk";

	@plugins.register("hello-world")
	export class HelloWorld {
	@mapper.onGroupAt()
	async helloWorld(groupContext: GroupContext) {
	await groupContext.post(groupContext.data.msg.group_openid, {
	msg_type: MessageType.TEXT,
	msg_id: groupContext.data.msg.id,
	content: "hello world",
	});
	}
	}

如果你想要自定义响应指令，可以通过 onGroupAt 中的 options 字段中的 command 设置，除此之外
，你还可以通过 priority 和 block 设置事件响应器优先级和是否阻塞

⚠️ 为了适配 QQ 官方的指令配置，默认响应指令头为 \ ，也就是说，如果你设置 command: 'hello' ，则需通过 /hello 触发

	// plugins/hello.ts
	import { mapper, plugins, GroupContext } from "mizuki-sdk";

	@plugins.register("hello")
	export class Hello {
	@mapper.onGroupAt({ command: "hello" })
	async hello(groupContext: GroupContext) {
	await groupContext.post(groupContext.data.msg.group_openid, {
	msg_type: MessageType.TEXT,
	msg_id: groupContext.data.msg.id,
	content: "hello",
	});
	}
	}

	// ⚠️ 注意别忘了在 plugin/index.ts 中添加导出语句

如果你还想为 server 配置更多选项，目前提供了日志等级设置和启用内建插件功能，你可以将 main.ts 中对 server 的调用更改为：

	// main.ts
	await server
	.setLogLevel("info")
	.useBuiltinPlugins(["echo", "get_message_data"])
	.run(config);

hello-hexo

2024-10-21T13:32:44.000Z

写在前头：经过一番兜兜转转，最后还是用 hexo 搭建了这个博客。~~就应该是静态博客~~

# 关于 halo

halo 用下来的体验还是可以的，我本来是想搭建一个博客平台，但后面发现~~其实根本没人会用你这个破平台~~。
然后你知道的 halo 的技术栈是 java,jvm 多少有点……