@hapipal/schmervice

中文文档
3.0.0发布于 2023/02/27MITTypeScriptCommonJS零依赖近 30 天下载 8540

Capi 的服务层

中文使用文档
文档目录5 节
  1. 安装
  2. 使用量
  3. 功能样式
  4. 利用现有图书馆作为服务
  5. 额外

缩写

Capi 的服务层

Build Status Coverage Status

主维护者 - 变形常春藤

安装

npm install @hapipal/schmervice

使用量

另见 API 参考

Schmervice是打算与 hopi v20+ 和 nodejs v16+ 一起使用的(下级支持请参见 v2) (中文(简体) ).

服务是将相关业务逻辑或交易组织成类的好方法. Schmervice是一个服务层,旨在与hopi很好地融合. 它由两个部分组成,可以一起使用或单独使用:

  1. 基础 Service 通过下列方式将您的服务整合到 hopi 的类:

    • 允许其接触相关的 server 和插件 options。 。 。 .
    • 允许您执行 async initialize() 财务报告和审定财务报表 async teardown() 当服务器初始化和停止时应当运行的方法.
    • 允许您将某些方法配置为可缓存, 并带有您习惯的所有服务器方法配置 .
  2. a hopi 插件,允许您注册服务并在最方便的地方访问服务,例如在路由处理器中。 这个注册尊重插件边界,并且是分级的,因此无关的插件可以安全地注册自己的服务而不会互相影响.

const Schmervice = require('@hapipal/schmervice');
const Hapi = require('@hapi/hapi');

(async () => {

    const server = Hapi.server();

    await server.register(Schmervice);

    server.registerService(
        class MathService extends Schmervice.Service {

            add(x, y) {

                this.server.log(['math-service'], 'Adding');

                return Number(x) + Number(y);
            }

            multiply(x, y) {

                this.server.log(['math-service'], 'Multiplying');

                return Number(x) * Number(y);
            }
        }
    );

    server.route({
        method: 'get',
        path: '/add/{a}/{b}',
        handler: (request) => {

            const { a, b } = request.params;
            const { mathService } = request.services();

            return mathService.add(a, b);
        }
    });

    await server.start();

    console.log(`Start adding at ${server.info.uri}`);
})();

功能样式

Schmervices允许您在以上显示的面向类方法之外,以功能风格写入服务. server.registerService() 可以通过普通对象或工厂函数。 只要确保您使用 Schmervice.name 符号或 name 属性。 以上例的功能调整如下:

const Schmervice = require('@hapipal/schmervice');
const Hapi = require('@hapi/hapi');

(async () => {

    const server = Hapi.server();

    await server.register(Schmervice);

    server.registerService(
        (srv) => ({
            [Schmervice.name]: 'mathService',
            add: (x, y) => {

                srv.log(['math-service'], 'Adding');

                return Number(x) + Number(y);
            },
            multiply: (x, y) => {

                srv.log(['math-service'], 'Multiplying');

                return Number(x) * Number(y);
            }
        })
    );

    server.route({
        method: 'get',
        path: '/add/{a}/{b}',
        handler: (request) => {

            const { a, b } = request.params;
            const { mathService } = request.services();

            return mathService.add(a, b);
        }
    });

    await server.start();

    console.log(`Start adding at ${server.info.uri}`);
})();

利用现有图书馆作为服务

也可以在您的应用程序中将已有的图书馆用作服务. 举个例子,我们如何利用 节点 作为发送电子邮件的服务。 此示例特征 Schmervice.withName(),这是一个方便的方式,可以使用 Schmervice.name 符号,类似于上面的例子:

const Schmervice = require('@hapipal/schmervice');
const Nodemailer = require('nodemailer');
const Hapi = require('@hapi/hapi');

(async () => {

    const server = Hapi.server();

    await server.register(Schmervice);

    server.registerService(
        Schmervice.withName('emailService', () => {

            // Sendmail is a simple transport to configure for testing, but if you're
            // not seeing the sent emails then make sure to check your spam folder.

            return Nodemailer.createTransport({
                sendmail: true
            });
        })
    );

    server.route({
        method: 'get',
        path: '/email/{toAddress}/{message*}',
        handler: async (request) => {

            const { toAddress, message } = request.params;
            const { emailService } = request.services();

            await emailService.sendMail({
                from: '[email protected]',
                to: toAddress,
                subject: 'A message for you',
                text: message
            });

            return { success: true };
        }
    });

    await server.start();

    console.log(`Start emailing at ${server.info.uri}`);
})();

额外

什么是服务层?

"服务层"是一个非常不准确的术语,因为它被各种开发者和应用程序以各种方式使用. 我们的目标不是规定你如何使用服务。 但一般情况下,人们可能会在"服务"中写出代码,作为将相关的业务逻辑,数据交易(如将记录保存到数据库)分组的方式,或者调用外部API. 有时服务层会表示一个"无头"界面,指您在一个应用程序中可以采取的所有动作,独立于任何传输(如HTTP),并且隐藏应用的数据层(或模型)从它的消费者那里.

就我们的情况而言,服务构成一个通用的“层”或你代码库的一部分——具体来说,它们只是每个服务器一次的类。 你可以用它,不管你觉得合适!

hopi实际上有一个与服务这一概念密切相关的特征: 服务器方法。我们喜欢服务器方法,但也认为它们作为低级API比直接用于中大型项目更有效。 如果你已经熟悉了hopi服务器方法,可以把schmervices看作是一个在工程学上创建和使用服务器方法(加上一些其他的铃声和口哨)的工具.

版本与发布记录

@hapipal/schmervice 共发布 4 个版本,首次发布于 2020/10/29;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.0latest2023/02/273 年前
2.1.02022/11/283 年前
2.1.0-types.0types2022/03/134 年前
2.0.02020/10/296 年前

关于 @hapipal/schmervice 的常见问题

@hapipal/schmervice 是什么?

Capi 的服务层

如何安装 @hapipal/schmervice?

在项目目录运行 npm install @hapipal/schmervice,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@hapi/hapi(>=20 <22)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@hapipal/schmervice 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@hapipal/schmervice 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@hapipal/schmervice 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=16。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@hapipal/schmervice 可以商用吗?

@hapipal/schmervice 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@hapipal/schmervice 的下载量有多少?

根据 npm 官方下载统计,@hapipal/schmervice 在 2026/10/17 – 2026/11/15 这 30 天内被下载 8,540 次,日均约 285 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@hapipal/schmervice 还在维护吗?

最新版本 3.0.0 发布于 2023/02/27(3 年前);至今共发布 4 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/10/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。