Notadd项目开发指南：模块与插件开发规范详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01009/article/details/148758165

Notadd项目开发指南：模块与插件开发规范详解

notadd A microservice development architecture based on nest.js. —— 基于 Nest.js 的微服务开发架构。项目地址: https://gitcode.com/gh_mirrors/no/notadd

前言

Notadd作为一个现代化的应用开发框架，采用了模块化和插件化的架构设计。本文将深入解析Notadd项目的开发规范，重点介绍模块和插件的开发流程与最佳实践，帮助开发者快速上手Notadd项目开发。

编码规范与项目结构

基础编码规范

Notadd项目采用TypeScript作为主要开发语言，并遵循以下编码规范：

命名规范：
- 类(Class)和接口(Interface)采用大驼峰命名法（PascalCase）
- 变量和属性采用小驼峰命名法（camelCase）
- 文件名采用短横线连接（kebab-case）
类型约束：
- 使用项目根目录下的tslint.json文件作为代码规范约束
- 严格类型检查，避免使用any类型

项目目录结构

模块标准结构

src
 |- controllers       # RPC控制器目录
 |- entities          # 数据库实体类目录  
 |- interfaces        # 接口定义目录
 |- protobufs         # Protobuf协议文件目录
 |- services          # 业务逻辑实现目录
 |- utils             # 工具类目录
xxx.module.ts         # 模块根程序
main.ts               # 模块启动程序

插件标准结构

src
 |- services          # 业务逻辑实现目录
 |- interfaces        # 接口定义目录
 |- utils             # 工具类目录
xxx.addon.ts          # 插件根程序  
index.ts              # 插件导出文件

模块开发详解

在Notadd架构中，模块是独立的微服务单元，具有以下特点：

每个模块都是独立的进程
只有模块可以直接操作数据库
模块间通过RPC进行通信
主程序作为API网关，对外提供GraphQL接口

模块开发五步法

第一步：定义Protobuf协议

Protobuf是模块间通信的协议基础，需要先定义服务接口：

syntax = "proto3";

package notadd_rpc_demo;

service RootService {
    rpc SayHello (SayHelloRequest) returns (SayHelloResponse) { }
}

message SayHelloRequest {
    string name = 1;
}

message SayHelloResponse {
    string msg = 1;
}

第二步：实现Service层

Service层包含核心业务逻辑实现：

import { Injectable } from '@nestjs/common';

@Injectable()
export class RootService {
    async sayHello(name: string) {
        return `Hello ${name}!`;
    }
}

第三步：实现Controller层

Controller层负责处理RPC调用：

import { Controller, Inject } from '@nestjs/common';
import { GrpcMethod } from '@nestjs/microservices';

@Controller()
export class RootController {
    constructor(
        @Inject(RootService) private readonly rootService: RootService
    ) { }

    @GrpcMethod('RootService')
    async sayHello(data: { name: string }) {
        return this.rootService.sayHello(data.name);
    }
}

关键点：

使用@GrpcMethod装饰器声明RPC方法
方法名必须与proto定义一致（首字母小写）
参数为对象结构，字段与proto定义对应

第四步：定义模块

import { Module } from '@nestjs/common';

@Module({
    controllers: [RootController],
    providers: [RootService]
})
export class AppModule { }

第五步：编写启动程序

import { Transport } from '@nestjs/common/enums/transport.enum';
import { NestFactory } from '@nestjs/core';

async function bootstrap() {
    const app = await NestFactory.createMicroservice(AppModule, {
        transport: Transport.GRPC,
        options: {
            url: 'localhost:50050',
            package: 'notadd_rpc_demo',
            protoPath: join(__dirname, './protobufs/root.proto')
        }
    });
    await app.listenAsync();
}

bootstrap();