ginstarter

README

Starter-Gin 项目

Starter-Gin 在 Starter 的基础上，实现了以依赖注入的方式，来配置并启动 Gin 服务。

安装

在安装 Starter-Gin 包之前, 需要先 安装 Starter 框架 。

1. 首先安装 Starter 框架, 然后你就能通过下列命令来安装 Starter-Gin 了。

    $ go get -u github.com/bitwormhole/starter-gin
   

2. 把它导入到你的代码:

    import ginstarter "github.com/bitwormhole/starter-gin"
   

快速开始

在工程文件夹下新建一个源文件，例如：example.go, 然后输入下列代码。

package main

import ginstarter "github.com/bitwormhole/starter-gin"

func main() {
    i := ginstarter.InitGin()
    i.Use(ginstarter.Module())
    i.Run()
}

运行这个例子：

$ go run example.go

更多

要了解更多内容，请访问： https://bitwormhole.com/starter-gin/

Documentation

Index

• func InitGin() application.Initializer
• func Module() application.Module
• func ModuleForDemo() application.Module
• func ModuleWithDevtools() application.Module
• type SimpleModuleBuilder
  • func SimpleModule() SimpleModuleBuilder

Functions

func InitGin

func InitGin() application.Initializer

InitGin 函数：开始初始化Gin应用程序

func Module

func Module() application.Module

Module 定义要导出的模块

func ModuleForDemo

func ModuleForDemo() application.Module

ModuleForDemo 定义要导出的模块(with demo)

func ModuleWithDevtools

func ModuleWithDevtools() application.Module

ModuleWithDevtools 定义要导出的模块(with devtools)

Types

type SimpleModuleBuilder

type SimpleModuleBuilder interface {

	// Name 设置模块的名称
	Name(name string) SimpleModuleBuilder

	// Version 设置模块的版本
	Version(ver string) SimpleModuleBuilder

	// Revision 设置模块的修订号码
	Revision(rev int) SimpleModuleBuilder

	// Resources 设置与模块绑定的资源
	Resources(r collection.Resources) SimpleModuleBuilder

	// Dependency 向模块添加一个依赖
	Dependency(dep application.Module) SimpleModuleBuilder

	// Dependencies 向模块添加一组依赖
	Dependencies(deps []application.Module) SimpleModuleBuilder

	// OnMount 添加一个钩子到 SimpleModuleBuilder
	OnMount(fn application.OnMountFunc) SimpleModuleBuilder

	// RegisterController 注册一个控制器, 【注意】在此注册的控制器无法作为依赖注入的目标，如果要向该控制器注入依赖，请使用标准的模块定义方式！
	RegisterController(ctrl glass.Controller) SimpleModuleBuilder

	// RegisterControllerFunc 以函数形式注册一个控制器
	RegisterControllerFunc(ctrl glass.ControllerFunc) SimpleModuleBuilder

	// Create 创建模块
	Create() application.Module
}

SimpleModuleBuilder 是用于快速创建自定义Gin模块的工具

func SimpleModule

func SimpleModule() SimpleModuleBuilder

SimpleModule 函数创建一个 SimpleModuleBuilder，【注意】 此方法无法向控制器注入依赖，如果需要注入，请使用标准的模块定义方式！