fns

README

FNS

---

Golang的函数式框架。标准化协议来简化开发过程。

特性

• 标准化
  • 万物皆函数
  • 天然分布式服务
• 适用于企业开发。
  • 环境化配置
  • 敏捷开发
  • 内置身份校验
  • 内置权限验证
  • 内置指标收集
  • 内置链路跟踪
  • 支持分布式跟踪的错误
  • 支持可检索的日志格式
  • 自动化分布式API文档
• 高并发
  • 协程池
  • 支持 Fasthttp
  • 栅栏
• TLS
  • 自动化自签证书
• 多版本HTTP
  • Fasthttp
  • 基于Fasthttp的HTTP2
  • 标准库
  • HTTP3
  • 通用的WEBSOCKET
• 集群
  • 分布式共享
  • 请求自动代理
  • Hazelcast
  • Redis
  • Kubernetes
• 官方服务
  • 数据库
    • SQL
      • 分布式事务
      • Postgres ORM
      • Mysql ORM
    • Redis
  • 消息
    • RabbitMQ
    • Kafka
    • RocketMQ
    • MQTT
  • 第三方服务集成
    • Oauth
    • 支付
    • 短信
    • 通知

使用

创建项目

一、安装fns。

go install github.com/aacfactory/fns/cmd/fns@latest

二、使用fns创建项目。

mkdir {your project path}
cd {your project path}
fns init --mod={mod} --img={docker image name} --work={true} --version={go version} . 
## Example
# fns init --mod=foo.com/project --img={foo.com/project} --work=true --version=1.21.0 .

编写代码

一、理解项目结构

二、设置配置与依赖

三、创建服务标识。

四、创建函数。

五、运行go generate生成代码。

运行项目

设置环境变量激活配置。

如FNS-ACTIVE=local，则运行时使用fns-local.yaml的配置。

测试与分析

• 单元测试
• pprof

发布API文档

开启API文档功能，通过浏览器或相关OPENAPI工具进行查阅。

集群

开启集群功能即可，无需其它改动。

当运行在kubernetes环境中时，请使用 inject 把 POD IP 注入到FNS-HOST环境变量中，最后把配置中cluster.hostRetriever的值设置为env。

客制化HTTP服务

• HTTP服务
• 中间件
• 处理器

第三方服务集成

服务化

服务化第三方服务的SDK，业务服务通过函数进行调用。

组件化

组件化第三方服务的SDK，然后注入到业务服务中。

Documentation

Index

• func ConfigActiveFromENV(key string) (active string)
• type Application
  • func New(options ...Option) (app Application)
• type Option
  • func ConfigRetriever(path string, format string, active string, prefix string, splitter byte) Option
  • func Handler(handler transports.MuxHandler) Option
  • func Hooks(h ...hooks.Hook) Option
  • func Id(id string) Option
  • func LogWriters(writers ...logs.Writer) Option
  • func Middleware(middleware transports.Middleware) Option
  • func Name(name string) Option
  • func Proxy(options ...proxies.Option) Option
  • func RegisterValidator(register validators.ValidateRegister) Option
  • func ShutdownTimeout(timeout time.Duration) Option
  • func Transport(transport transports.Transport) Option
  • func Version(version string) Option
• type Options

Functions

func ConfigActiveFromENV

func ConfigActiveFromENV(key string) (active string)

Types

type Application

type Application interface {
	Deploy(service ...services.Service) Application
	Run(ctx context.Context) Application
	Sync()
}

func New

func New(options ...Option) (app Application)

type Option

type Option func(*Options) error

func ConfigRetriever

func ConfigRetriever(path string, format string, active string, prefix string, splitter byte) Option

func Handler

func Handler(handler transports.MuxHandler) Option

func Hooks

func Hooks(h ...hooks.Hook) Option

func Id

func Id(id string) Option

func LogWriters

func LogWriters(writers ...logs.Writer) Option

func Middleware

func Middleware(middleware transports.Middleware) Option

func Name

func Name(name string) Option

func Proxy

func Proxy(options ...proxies.Option) Option

func RegisterValidator

func RegisterValidator(register validators.ValidateRegister) Option

func ShutdownTimeout

func ShutdownTimeout(timeout time.Duration) Option

func Transport

func Transport(transport transports.Transport) Option

func Version

func Version(version string) Option

type Options

type Options struct {
	// contains filtered or unexported fields
}