freedom

README

freedom

freedom是一个基于六边形架构的框架，可以支撑充血的领域模型范式。

Overview

• 集成iris v12
• 集成普罗米修斯
• 无侵入式Trace
• 基于组件式的基础设施扩展
• http2 server & client
• 依赖注入 & 依赖倒置
• CRUD & PO 代码生成
• DDD & 六边形架构
• 消息事件 & 事件重试 & 领域事件
• 一级缓存 & 二级缓存 & 防击穿

安装

$ go get github.com/8treenet/freedom/freedom

脚手架创建项目

$ freedom new-project [project-name]

脚手架生成增删查改和持久化对象

# 编辑 [project-name]/server/conf/db.toml 填入数据库地址
# freedom new-po -h 查看更多
$ cd [project-name]
$ freedom new-po

Example

基础教程

http2监听和依赖倒置

事务组件和自定义组件

消息事件和领域事件

一个完整的电商demo,包含CQRS、聚合、实体、领域事件、资源库、基础设施

Documentation

Index

• func Configure(obj interface{}, file string, must bool, metaData ...interface{})
• func HandleBusMiddleware(worker Worker)
• func Logger() *golog.Logger
• func Prepare(f func(Initiator))
• func Prometheus() *internal.Prometheus
• func SetConfigurer(confer Configurer)
• type Application
  • func NewApplication() Application
• type BeforeActivation
• type Bus
• type BusHandler
• type Configuration
  • func DefaultConfiguration() Configuration
• type Configurer
• type Context
• type DomainEventInfra
• type Entity
• type Infra
• type Initiator
• type LogFields
• type LogRow
• type Repository
• type Result
• type SingleBoot
• type Starter
• type UnitTest
  • func NewUnitTest() UnitTest
• type Worker
  • func ToWorker(ctx Context) Worker

Functions

func Configure

func Configure(obj interface{}, file string, must bool, metaData ...interface{})

Configure .

func HandleBusMiddleware

func HandleBusMiddleware(worker Worker)

HandleBusMiddleware middleware processing.

func Logger

func Logger() *golog.Logger

Logger .

func Prepare

func Prepare(f func(Initiator))

Prepare .

func Prometheus

func Prometheus() *internal.Prometheus

Prometheus .

func SetConfigurer

func SetConfigurer(confer Configurer)

SetConfigurer .

Types

type Application

type Application interface {
	InstallDB(f func() (db interface{}))
	InstallRedis(f func() (client redis.Cmdable))
	InstallOther(f func() interface{})
	InstallMiddleware(handler iris.Handler)
	InstallParty(relativePath string)
	CreateH2CRunner(addr string, configurators ...host.Configurator) iris.Runner
	CreateRunner(addr string, configurators ...host.Configurator) iris.Runner
	Iris() *iris.Application
	Logger() *golog.Logger
	Run(serve iris.Runner, c iris.Configuration)
	InstallDomainEventInfra(eventInfra DomainEventInfra)
	Start(f func(starter Starter))
	InstallBusMiddleware(handle ...BusHandler)
	InstallSerializer(marshal func(v interface{}) ([]byte, error), unmarshal func(data []byte, v interface{}) error)
	CallService(fun interface{}, worker ...Worker)
}

Application .

func NewApplication

func NewApplication() Application

NewApplication .

type BeforeActivation

type BeforeActivation = mvc.BeforeActivation

BeforeActivation is Is the start-up pre-processing of the action..

type Bus

type Bus = internal.Bus

Bus is the bus message type.

type BusHandler

type BusHandler = internal.BusHandler

BusHandler is the bus message middleware type.

type Configuration

type Configuration = iris.Configuration

Configuration is the configuration type of the app.

func DefaultConfiguration

func DefaultConfiguration() Configuration

DefaultConfiguration the default profile.

type Configurer

type Configurer interface {
	Configure(obj interface{}, file string, must bool, metaData ...interface{})
}

Configurer .

type Context

type Context = iris.Context

Context is the context type.

type DomainEventInfra

type DomainEventInfra = internal.DomainEventInfra

DomainEventInfra is a dependency inverted interface for domain events.

type Entity

type Entity = internal.Entity

Entity is the entity's father interface.

type Infra

type Infra = internal.Infra

Infra .

type Initiator

type Initiator = internal.Initiator

Initiator .

type LogFields

type LogFields = golog.Fields

LogFields is the column type of the log.

type LogRow

type LogRow = golog.Log

LogRow is the log per line callback.

type Repository

type Repository = internal.Repository

Repository .

type Result

type Result = hero.Result

Result is the controller return type.

type SingleBoot

type SingleBoot = internal.SingleBoot

SingleBoot .

type Starter

type Starter = internal.Starter

Starter is the startup interface.

type UnitTest

type UnitTest = internal.UnitTest

UnitTest is a unit test tool.

func NewUnitTest

func NewUnitTest() UnitTest

NewUnitTest .

type Worker

type Worker = internal.Worker

Worker .

func ToWorker

func ToWorker(ctx Context) Worker

ToWorker the context is converted to a worker.