fns

README

Fns

---

Fn services for Golang. Simplify the development process by using standardized development scheme. Every thing is function.

Features

• Applicable to enterprise projects
  • Standardization
  • Environmental configuration
  • Rapid development by code-generations
  • Built in authorizations service
  • Built in permission service
  • Built in metric
  • Built in tracing
  • Traceable and searchable error
  • Searchable log
• High concurrency
  • Goroutines pool
  • Fasthttp
  • Barrier
• TLS
  • Standard
  • SSC
  • ACMEs
• Cluster
  • sharding
  • Hazelcast
  • Redis
• Official services
  • Database
    • SQL
      • Distributed transaction
      • Postgres ORM
      • Mysql ORM
    • Redis
  • Message queue
    • RabbitMQ
    • Kafka
    • RocketMQ
  • Third party integration
    • Oauth
    • Payments
    • SMS
    • Notifications
• Documents
  • Openapi
  • Official

Quickstart

Creation

First: install fns commander.

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

Second: use fns create a fns project.

mkdir {your project path}
cd {your project path}
fns init --mod={mod_name} . 

Third: look main.go, configs, modules to understand project structure.

Last: add dependencies and setup config.

Coding

1. First: create a service ident.
2. Second: create a function.
3. Last: run go generate to generate source codes.
4. Happy coding.

Running

Setup FNS-ACTIVE env, such as FNS-ACTIVE=local, that the fns-local.yaml is used.

View documents

Setup documents, then done, so easy.

Testing

• Use tests to make writing test units easy.
• Use pprof to analysis of profiling data.

Cluster

Use hazelcast or redis, and create a proxy server as gateway, then done, so easy.
When used in kubernetes, then inject pod ip into FNS-HOST, and set env into config field cluster.hostRetriever.

Customize transport

• Server
• Middleware

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
}