freedom

README

Freedom DDD Framework

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

Overview

• 集成 Iris
• HTTP/H2C Server & Client
• 集成普罗米修斯
• AOP Worker & 无侵入 Context
• 可扩展组件 Infrastructure
• 依赖注入 & 依赖倒置 & 开闭原则
• DDD & 六边形架构
• 领域事件 & 消息队列组件
• CQS & 聚合根
• CRUD & PO Generate
• 一级缓存 & 二级缓存 & 防击穿

安装

$ go install github.com/8treenet/freedom/freedom@latest
$ freedom version

脚手架创建项目

$ freedom new-project [project-name]
$ cd [project-name]
$ go mod tidy
$ go run server/main.go

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

# freedom new-po -h 查看更多
$ cd [project-name]

# 数据库数据源方式
$ freedom new-po --dsn "root:123123@tcp(127.0.0.1:3306)/freedom?charset=utf8"

# JSON 数据源方式
$ freedom new-po --json ./domain/po/schema.json

Example

基础教程

http2 监听和依赖倒置

事务组件&自定义组件&Kafka&领域事件组件

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

Documentation

Index

• Constants
• Variables
• func Configure(obj interface{}, file string, metaData ...interface{}) error
• func DefaultConfiguration() iris.Configuration
• func IsDir(dir string) bool
• func IsFile(path string) bool
• func JoinPath(elems ...string) string
• func Logger() *golog.Logger
• func Prepare(f func(Initiator))
• func ProfileDirFromEnv() string
• func Prometheus() *internal.Prometheus
• func ReadProfile(file string, v interface{}) error
• func ServiceLocator() *internal.ServiceLocatorImpl
• func SetConfigurator(c Configurator)
• func SetConfigurer(c Configurer)
• type Application
  • func NewApplication() Application
• type BeforeActivation
• type BootManager
• type Bus
• type BusHandler
• type Configuration
• type Configurator
• type Configurer
• type Context
• type DomainEvent
• type Entity
• type Infra
• type Initiator
• type IrisBeforeActivation
• type IrisConfiguration
• type IrisContext
• type IrisResult
• type LogFields
• type LogRow
• type Repository
• type Result
• type UnitTest
  • func NewUnitTest() UnitTest
• type Worker
  • func ToWorker(ctx Context) Worker
  • func WorkerFromCtx(ctx Context) Worker

Constants

const (
	//TransactionKey for transaction DB handles in the first-level cache
	TransactionKey = internal.TransactionKey
)

Variables

var (

	// EnvProfileDir is the name of the environment variable for the search
	// directory of the profile
	EnvProfileDir = "FREEDOM_PROJECT_CONFIG"

	// ProfileENV is the name of the profile directory in environment variable
	ProfileENV = EnvProfileDir
)

Functions

func Configure

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

Configure .

func DefaultConfiguration

func DefaultConfiguration() iris.Configuration

DefaultConfiguration Proxy a call to iris.DefaultConfiguration

func IsDir

func IsDir(dir string) bool

IsDir accepts a string with a directory path and tests the path. It returns true if the path exists and it is a directory, and false otherwise.

func IsFile

func IsFile(path string) bool

IsFile accepts a string with a file path and tests the path. It returns true if the path exists and it is a file, and false otherwise.

func JoinPath

func JoinPath(elems ...string) string

JoinPath returns a string that joins any number of path elements into a single path, separating them with slashes.

func Logger

func Logger() *golog.Logger

Logger Return to global logger.

func Prepare

func Prepare(f func(Initiator))

Prepare A prepared function is passed in for initialization.

func ProfileDirFromEnv

func ProfileDirFromEnv() string

ProfileDirFromEnv reads from environment variable with EnvProfileDir

func Prometheus

func Prometheus() *internal.Prometheus

Prometheus Return prometheus.

func ReadProfile

func ReadProfile(file string, v interface{}) error

ReadProfile accepts a string with the name of a profile file, and search the file by detectProfilePath. It will fill v with the configuration by parsing the profile into toml format, and returns nil if the file has found. It returns error, if the file has not been found or any error encountered.

func ServiceLocator

func ServiceLocator() *internal.ServiceLocatorImpl

ServiceLocator Return serviceLocator. Use the service locator to get the service.

func SetConfigurator

func SetConfigurator(c Configurator)

SetConfigurator assigns a Configurator to global configurator

func SetConfigurer

func SetConfigurer(c Configurer)

SetConfigurer assigns a Configurator to global configurator

Types

type Application

type Application interface {
	// Install the database. A function that returns the Interface type is passed in as a handle to the database.
	InstallDB(f func() (db interface{}))
	// Install the redis. A function that returns the redis.Cmdable is passed in as a handle to the client.
	InstallRedis(f func() (client redis.Cmdable))
	// Install a custom data source. A function that returns the Interface type is passed in as a handle to the custom data sources.
	InstallCustom(f func() interface{})
	// Install the middleware for http routing globally.
	InstallMiddleware(handler iris.Handler)
	// Assigns specified prefix to the application-level router.
	// Because of ambiguous naming, I've been create SetPrefixPath as an alternative.
	// Considering remove this function in the future.
	InstallParty(relativePath string)
	// NewRunner Can be used as an argument for the `Run` method.
	NewRunner(addr string, configurators ...host.Configurator) iris.Runner
	// NewH2CRunner Create a Runner for H2C .
	NewH2CRunner(addr string, configurators ...host.Configurator) iris.Runner
	// NewAutoTLSRunner Can be used as an argument for the `Run` method.
	NewAutoTLSRunner(addr string, domain string, email string, configurators ...host.Configurator) iris.Runner
	// NewTLSRunner Can be used as an argument for the `Run` method.
	NewTLSRunner(addr string, certFile, keyFile string, configurators ...host.Configurator) iris.Runner
	// Go back to the iris app.
	Iris() *iris.Application
	// Return to global logger.
	Logger() *golog.Logger
	// Run serving an iris application as the HTTP server to handle the incoming requests
	Run(serve iris.Runner, c iris.Configuration)
	// Adds a builder function which builds a BootManager.
	BindBooting(f func(bootManager BootManager))
	// Install the middleware for the message bus.
	InstallBusMiddleware(handle ...BusHandler)
	InstallSerializer(marshal func(v interface{}) ([]byte, error), unmarshal func(data []byte, v interface{}) error)
}

Application Represents an application of freedom

func NewApplication

func NewApplication() Application

NewApplication Create an application.

type BeforeActivation

type BeforeActivation = IrisBeforeActivation

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

type BootManager

type BootManager = internal.BootManager

BootManager Can be used to launch in the application.

type Bus

type Bus = internal.Bus

Bus Message bus, using http header to pass through data.

type BusHandler

type BusHandler = internal.BusHandler

BusHandler is the bus message middleware type.

type Configuration

type Configuration = IrisConfiguration

Configuration is the configuration type of the app.

type Configurator

type Configurator interface {
	Configure(obj interface{}, file string, metaData ...interface{}) error
}

Configurator .

type Configurer

type Configurer = Configurator

Configurer .

type Context

type Context = IrisContext

Context is the context type.

type DomainEvent

type DomainEvent = internal.DomainEvent

DomainEvent Interface definition of domain events for subscription and publishing of entities.

type Entity

type Entity = internal.Entity

Entity is the entity's father interface.

type Infra

type Infra = internal.Infra

Infra The parent class of the infrastructure, which can be inherited using the parent class's methods.

type Initiator

type Initiator = internal.Initiator

Initiator Initialize the binding relationship between the user's code and the associated code.

type IrisBeforeActivation

type IrisBeforeActivation = mvc.BeforeActivation

IrisBeforeActivation represents an type alias to mvc.BeforeActivation

type IrisConfiguration

type IrisConfiguration = iris.Configuration

IrisConfiguration represents an type alias to iris.Configuration

type IrisContext

type IrisContext = iris.Context

IrisContext represents an type alias to iris.Context

type IrisResult

type IrisResult = hero.Result

IrisResult represents an type alias to hero.Result

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 The parent class of the repository, which can be inherited using the parent class's methods.

type Result

type Result = IrisResult

Result is the controller return type.

type UnitTest

type UnitTest = internal.UnitTest

UnitTest is a unit test tool.

func NewUnitTest

func NewUnitTest() UnitTest

NewUnitTest Unit testing tools.

type Worker

type Worker = internal.Worker

Worker Request a runtime object.

func ToWorker

func ToWorker(ctx Context) Worker

ToWorker proxy a call to WorkerFromCtx.

func WorkerFromCtx

func WorkerFromCtx(ctx Context) Worker

WorkerFromCtx extracts Worker from a Context.