Seneca 微服务工具包技术文档

1. 安装指南

1.1 使用 npm 安装

要安装 Seneca，请在终端中运行以下命令：

npm install seneca

1.2 运行示例

安装完成后，您可以通过运行以下命令来启动示例微服务：

node microservice.js

其中 microservice.js 是一个使用 Seneca 的脚本文件。日志将以 JSON 格式输出，便于发送到日志服务。

1.3 测试模式

要在测试模式下运行，并启用人类可读的完整调试日志，请使用以下命令：

node microservice.js --seneca.test

2. 项目使用说明

2.1 概述

Seneca 是一个用于编写微服务架构的 Node.js 工具包。它通过模式匹配和传输独立性，帮助开发者将应用程序的业务逻辑分解为“发生的事情”，而不是专注于数据模型或依赖管理。

2.2 核心功能

• 模式匹配：灵活处理业务需求。
• 传输独立性：消息如何到达正确的服务器由 Seneca 处理，开发者无需担心。
• 成熟度：经过 8 年的生产环境验证。
• 插件生态：拥有丰富的插件生态系统。
• 书籍指南：提供微服务架构设计的指南。

2.3 快速示例

以下是一个简单的 Seneca 示例，展示了如何定义和使用插件：

'use strict'

var Seneca = require('seneca')

function rejector () {
  this.add('cmd:run', (msg, done) => {
    return done(null, {tag: 'rejector'})
  })
}

function approver () {
  this.add('cmd:run', (msg, done) => {
    return done(null, {tag: 'approver'})
  })
}

function local () {
  this.add('cmd:run', function (msg, done) {
    this.prior(msg, (err, reply) => {
      return done(null, {tag: reply ? reply.tag : 'local'})
    })
  })
}

Seneca()
  .use(approver)
  .listen({type: 'http', port: '8260', pin: 'cmd:*'})

Seneca()
  .use(rejector)
  .listen(8270)

function handler (err, reply) {
  console.log(err, reply)
}

Seneca()
  .use(local)
  .act('cmd:run', handler)

Seneca()
  .client({port: 8270, pin: 'cmd:run'})
  .client({port: 8260, pin: 'cmd:run'})
  .use(local)
  .act('cmd:run', handler)

Seneca()
  .client({port: 8260, pin: 'cmd:run'})
  .client({port: 8270, pin: 'cmd:run'})
  .use(local)
  .act('cmd:run', handler)

3. 项目 API 使用文档

3.1 seneca.add()

用于定义一个新的模式和对应的处理函数。例如：

seneca.add({cmd: 'salestax'}, function (msg, done) {
  var rate  = 0.23
  var total = msg.net * (1 + rate)
  done(null, {total: total})
})

3.2 seneca.act()

用于触发一个模式匹配的动作。例如：

seneca.act({cmd: 'salestax', net: 100}, function (err, result) {
  console.log(result.total)
})

3.3 seneca.listen()

用于启动一个监听器，接收 JSON 消息并执行相应的动作。例如：

seneca.listen()

3.4 seneca.client()

用于将无法本地匹配的动作发送到网络上的其他服务。例如：

seneca.client()

4. 项目安装方式

4.1 通过 npm 安装

npm install seneca

4.2 运行项目

node microservice.js

4.3 测试模式

node microservice.js --seneca.test

通过以上步骤，您可以轻松安装并开始使用 Seneca 微服务工具包。