langgo

README

Langgo Framework

Langgo是一款go语言开发应用的框架。

目录

• 安装
• 快速开始
• 组件
  • mysql
  • redis
• helper
  • rsa
  • aes
  • grpc
• 自定义组件
• goreleaser使用

安装

基于go 1.19开发

1. 安装langgo

go get -u github.com/langwan/langgo

1. 导入

import "github.com/langwan/langgo"

快速开始

package main

import (
	"github.com/langwan/langgo"
	"github.com/langwan/langgo/components/hello"
	"github.com/langwan/langgo/core/log"
)

func main() {
	langgo.Run(&hello.Instance{Message: "hello component"})
	log.Logger("component", "hello").Info().Msg(hello.GetInstance().Message)
}

组件

组件有两个特征，需要配置或者需要持久化的实例，例如mysql，需要对数据库连接参数进行配置，连接也需要持久化在内存当中，这两种情况下需要制作成组件。langgo有一些内置的组件。

grpc

grpc支持单机模式和etcd服务发现两种模式，可以参考examples/grpc/single和examples/grpc/etcd两个例子。

完成特性：

• 支持etcd等服务发现模式
• 支持tls双向认证
• 支持链表式多中间件

mysql

参考 examples/mysql，实际整合了gorm

mysql配置支持多个mysql账号，例如：

mysql:
  main:
    dsn: main:123456@tcp(localhost:3306)/simple?charset=utf8mb4&parseTime=True&loc=Local
    conn_max_lifetime: 1h
    max_idle_conns: 1
    max_open_conns: 10
  order:
    dsn: order:123456@tcp(localhost:3306)/simple?charset=utf8mb4&parseTime=True&loc=Local
    conn_max_lifetime: 1h
    max_idle_conns: 1
    max_open_conns: 10

这样可以支持项目会拥有多个mysql数据库

langgo.Run(&mysql.Instance{})
var one int
mysql.Main().Raw("SELECT 1").Scan(&one)
fmt.Println(one)

mysql.Main() 表示获取配置中main下的mysql配置，如果想获取order，需要使用 mysql.Get("order")

redis

与mysql差不多，可以对redis进行配置并使用多个redis数据源，可以对redis连接池进行配置，实际上整合了go-reids

helper

无需配置和内存持久化，直接调用的函数集合。

rsa

支持 加密、解密、创建密钥（根据长度）、签名、校验等方法

aes

支持加密、解密等方法

自定义组件

完全可以在自己的项目中实现自定义组件与使用langgo框架中的内置组件的方式一样，只需要您在自己的项目里拷贝出hello组件的代码，进行改造，然后在启动的时候放在langgo.Run里一起启动就可以了：

langgo.Run(&my.Instance{})

组件的配置文件放在app.yml配置中就可以了，例如：

my:
  message: my name is langgo

可以参考 examples/component/custom 这个例子

goreleaser使用

//初始化项目
goreleaser init

//发布在本地的版本
goreleaser release --snapshot --rm-dist //删除本地打包文件夹并打包

//发布在github的版本
//1.设置token
export GITHUB_TOKEN="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"

//2.添加tag
git tag -a v0.1.0 -m "First Release"
git push origin v0.1.0

//3.发布
goreleaser release

Documentation

Index

• func Init()
• func Run(instances ...core.Component)

Functions

func Init

func Init()

func Run

func Run(instances ...core.Component)