moov/bai2

moov-io/bai2

Moov的使命是为开发者提供简单的方式来创建和集成银行处理功能到自己的软件产品中。我们的开源项目专注于解决***服务中的单一职责，围绕性能、可扩展性和易用性设计。

Bai2实现了银行管理协会（Bank Administration Institute）制定的现金管理余额报告规范第2版)的读取器、写入器和验证器。该项目提供一个包含HTTP服务器的Docker镜像和Go包github.com/moov-io/bai2。

目录

• 项目状态
• 使用方法
  • 作为API
    • Docker
    • Google Cloud Run
    • 数据持久化
  • 作为Go模块
  • 作为命令行工具
• 了解BAI2
• 获取帮助
• 支持和测试的平台
• 贡献
• 相关项目

项目状态

Moov Bai2已在多个生产环境中积极使用。如果您对其进展感兴趣，请为项目点赞。如果您有基于Bai2的上层应用来简化任务、执行业务操作，或发现错误，欢迎提交issue或pull request。感谢您的支持！

使用方法

Bai2项目实现了一个HTTP服务器和https://pkg.go.dev/github.com/moov-io/bai2%EF%BC%8C%E7%94%A8%E4%BA%8E%E5%88%9B%E5%BB%BA%E5%92%8C%E4%BF%AE%E6%94%B9BAI2%E6%A0%BC%E5%BC%8F%E6%96%87%E4%BB%B6%E3%80%82BAI2%E6%A0%BC%E5%BC%8F%E6%98%AF%E4%B8%80%E7%A7%8D%E9%80%9A%E7%94%A8%E6%A0%BC%E5%BC%8F%EF%BC%8C%E8%A2%AB%E7%BE%8E%E5%9B%BD%E5%A4%A7%E5%A4%9A%E6%95%B0%E9%93%B6%E8%A1%8C%E5%B9%BF%E6%B3%9B%E6%8E%A5%E5%8F%97%E3%80%82

Docker

我们在Docker Hub上发布了公开Docker镜像moov/bai2，包含每个标记的Bai2版本。无需配置即可在:8080端口提供服务。我们还为OpenShift提供Docker镜像，发布为quay.io/moov/bai2。

拉取并启动Docker镜像：

bash
docker pull moov/bai2:latest
docker run -p 8080:8080 moov/bai2:latest

上传文件并解析：

bash
curl -X POST --form "input=@sample.txt" http://localhost:8080/parse

json
{"status":"valid file"}

解析后打印文件：

bash
curl -X POST --form "input=@sample.txt" http://localhost:8080/print

01,0004,12345,060321,0829,001,80,1,2/
02,12345,0004,1,060317,,CAD,/
03,10200123456,CAD,040,+000000000000,,,045,+000000000000,,/
88,100,000000000208500,00003,V,060316,,400,000000000208500,00008,V,060316,/
16,409,000000000002500,V,060316,,,,RETURNED CHEQUE     /
16,409,000000000090000,V,060316,,,,RTN-UNKNOWN         /
16,409,000000000000500,V,060316,,,,RTD CHQ SERVICE CHRG/
16,108,000000000203500,V,060316,,,,TFR 1020 0345678    /
16,108,000000000002500,V,060316,,,,MACLEOD MALL        /
16,108,000000000002500,V,060316,,,,MASCOUCHE QUE       /
16,409,000000000020000,V,060316,,,,1000 ISLANDS MALL   /
16,409,000000000090000,V,060316,,,,PENHORA MALL        /
16,409,000000000002000,V,060316,,,,CAPILANO MALL       /
16,409,000000000002500,V,060316,,,,GALERIES LA CAPITALE/
16,409,000000000001000,V,060316,,,,PLAZA ROCK FOREST   /
49,+00000000000834000,000000014/
03,10200123456,CAD,040,+000000000000,,,045,+000000000000,,/
88,100,000000000111500,00002,V,060317,,400,000000000111500,00004,V,060317,/
16,108,000000000011500,V,060317,,,,TFR 1020 0345678    /
16,108,000000000100000,V,060317,,,,MONTREAL            /
16,409,000000000100000,V,060317,,,,GRANDFALL NB        /
16,409,000000000009000,V,060317,,,,HAMILTON ON         /
16,409,000000000002000,V,060317,,,,WOODSTOCK NB        /
16,409,000000000000500,V,060317,,,,GALERIES RICHELIEU  /
49,+00000000000446000,000000009/
98,+00000000001280000,000000002,000000025/
99,+00000000001280000,000000001,000000027/
...

Google Cloud Run

要在托管环境中开始使用，您可以将此项目部署到Google Cloud Platform。

从Google Cloud控制台创建新项目，命名为：

moov-bai2-demo

为项目启用Container Registry API，并关联账单账户（如需要）。然后，打开Cloud Shell终端，运行以下Docker命令，替换您的唯一项目ID：

bash
docker pull moov/bai2
docker tag moov/bai2 gcr.io/<PROJECT-ID>/bai2
docker push gcr.io/<PROJECT-ID>/bai2

将容器部署到Cloud Run：

bash
gcloud run deploy --image gcr.io/<PROJECT-ID>/bai2 --port 8080

选择目标平台为1，服务名称为bai2，区域选择离您最近的（如出现提示，启用Google API服务）。部署成功后，您将获得API部署的URL：

https://YOUR-BAI2-APP-URL.a.run.app

现在可以执行健康检查：

bash
curl https://YOUR-BAI2-APP-URL.a.run.app/health

应得到响应：

json
{"health":true}

数据持久化

根据设计，Bai2不持久化（保存）任何关于创建的文件或条目详情的数据。唯一的存储发生在进程内存中，重启Bai2后将不会保存任何文件或数据。此外，不对数据进行内存加密。

Go库

该项目使用Go Modules，需要Go v1.18或更高版本。有关设置Go的帮助，请参见Golang安装说明。您可以下载源代码，我们也提供https://github.com/moov-io/bai2/releases/latest%E3%80%82%E5%BC%BA%E7%83%88%E5%BB%BA%E8%AE%AE%E5%9C%A8%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83%E4%B8%AD%E4%BD%BF%E7%94%A8%E6%A0%87%E8%AE%B0%E7%89%88%E6%9C%AC%E3%80%82

bash
$ git@github.com:moov-io/bai2.git

$ go get -u github.com/moov-io/bai2

$ go doc github.com/moov-io/bai2

命令行

Bai2提供命令行界面，用于管理BAI2文件和启动Web服务。

bash
bai2 --help

Usage:
   [command]

Available Commands:
  help        Help about any command
  print       Print bai2 file
  parse       Parse bai2 file
  web         Launches web server

Flags:
  -h, --help           help for this command
      --input string   bai2 report file

Use " [command] --help" for more information about a command.

库支持的每种交互都通过命令行选项公开：

了解BAI2

• BAI2格式
• 现金管理

获取帮助

支持和测试的平台

• 64位Linux（Ubuntu、Debian）、macOS和Windows

贡献

欢迎贡献！请查看我们的贡献指南和行为准则开始！

该项目使用Go Modules，需要Go v1.18或更高版本。有关设置Go的帮助，请参见Golang安装说明。您可以下载源代码，我们也提供https://github.com/moov-io/bai2/releases/latest%E3%80%82%E5%BC%BA%E7%83%88%E5%BB%BA%E8%AE%AE%E5%9C%A8%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83%E4%B8%AD%E4%BD%BF%E7%94%A8%E6%A0%87%E8%AE%B0%E7%89%88%E6%9C%AC%E3%80%82

发布

要发布bai2版本，只需打开一个pull request，更新CHANGELOG.md和version.go，包含下一个版本号和详细信息。还需要将标签（如git push origin v1.0.0）推送到origin，以便CI进行发布。

测试

我们维护全面的单元测试套件，建议在特定函数需要多个类似测试用例时使用表格驱动测试。要运行当前目录中的所有测试文件，使用go test。当前总体覆盖率可在Codecov上查看。

模糊测试

我们目前通过https://hub.docker.com/r/moov/bai2fuzz Docker镜像对ImageCashLetter进行模糊测试。您可以了解更多或运行该镜像，并向security@moov.io报告崩溃示例。谢谢！

相关项目

作为Moov提供开源***科技基础设施计划的一部分，我们有许多活跃项目可能对您有用：

• https://github.com/moov-io/watchman%EF%BC%9A%E6%8F%90%E4%BE%9B%E5%AF%B9%E7%BE%8E%E5%9B%BD%E5%92%8C%E6%AC%A7%E7%9B%9F%E4%BC%97%E5%A4%9A%E8%B4%B8%E6%98%93%E5%88%B6%E8%A3%81%E6%B8%85%E5%8D%95%E7%9A%84%E6%90%9C%E7%B4%A2%E5%8A%9F%E8%83%BD%E3%80%82

• https://github.com/moov-io/fed%EF%BC%9A%E5%AE%9E%E7%8E%B0%E7%94%A8%E4%BA%8E%E6%90%9C%E7%B4%A2%E7%BE%8E%E5%9B%BD%E8%81%94%E9%82%A6%E5%82%A8%E5%A4%87%E7%B3%BB%E7%BB%9F%E7%9A%84%E5%AE%9E%E7%94%A8%E6%9C%8D%E5%8A%A1%EF%BC%8C%E5%A6%82ABA%E8%B7%AF%E7%94%B1%E5%8F%B7%E7%A0%81%E3%80%81***%E6%9C%BA%E6%9E%84%E5%90%8D%E7%A7%B0%E6%9F%A5%E6%89%BE%E4%BB%A5%E5%8F%8AFedACH%E5%92%8CFedwire%E8%B7%AF%E7%94%B1%E4%BF%A1%E6%81%AF%E3%80%82

• https://github.com/moov-io/wire%EF%BC%9A%E5%AE%9E%E7%8E%B0%E7%94%A8%E4%BA%8EFedwire%E8%B5%84%E9%87%91%E6%9C%8D%E5%8A%A1%E7%9A%84%E6%96%87%E4%BB%B6%E5%86%99%E5%85%A5%E6%8E%A5%E5%8F%A3%EF%BC%8C%E8%BF%99%E6%98%AF%E7%94%B1%E7%BE%8E%E5%9B%BD%E8%81%94%E9%82%A6%E5%82%A8%E5%A4%87%E9%93%B6%E8%A1%8C%E8%BF%90%E8%90%A5%E7%9A%84%E5%AE%9E%E6%97%B6%E5%85%A8%E9%A2%9D%E7%BB%93%E7%AE%97%E8%B5%84%E9%87%91%E8%BD%AC%E8%B4%A6%E7%B3%BB%E7%BB%9F%E3%80%82

• https://github.com/moov-io/ach%EF%BC%9A%E6%8F%90%E4%BE%9BACH%E6%96%87%E4%BB%B6%E7%94%9F%E6%88%90%E5%92%8C%E8%A7%A3%E6%9E%90%EF%BC%8C%E6%94%AF%E6%8C%81%E7%BE%8E%E5%9B%BD%E4%B8%BB%E8%A6%81%E8%B5%84%E9%87%91%E8%BD%AC%E7%A7%BB%E6%96%B9%E5%BC%8F%E7%9A%84%E6%89%80%E6%9C%89%E6%A0%87%E5%87%86%E6%9D%A1%E7%9B%AE%E4%BB%A3%E7%A0%81%E3%80%82

• https://github.com/moov-io/imagecashletter%EF%BC%9A%E5%AE%9E%E7%8E%B0%E7%94%A8%E4%BA%8ECheck21%E3%80%81X.9%E6%88%96%E6%94%AF%E7%A5%A8%E6%88%AA%E6%96%AD%E6%96%87%E4%BB%B6%E7%9A%84%E5%9B%BE%E5%83%8F%E7%8E%B0%E9%87%91%E4%BF%A1%E5%87%BD%EF%BC%88ICL%EF%BC%89%E6%96%87%E4%BB%B6%EF%BC%8C%E7%94%A8%E4%BA%8E%E7%BE%8E%E5%9B%BD%E7%9A%84%E4%BA%A4%E6%8D%A2%E5%92%8C%E8%BF%9C%E7%A8%8B%E5%AD%98%E6%AC%BE%E3%80%82

许可证

Apache License 2.0 - 详见LICENSE。