教程

系统安装

审批流框架基于最新的goravel进行适配，版本号为v1.1.14，请在安装完goravel后，在进行框架集成操作。goravel安装请访问goravel官网，使用文档：文档

1. 安装扩展

go get  github.com/hulutech-web/goravel-workflow

1.1 注册服务提供者:config/app.go

import	"github.com/hulutech-web/goravel-workflow"
func init() {
"providers": []foundation.ServiceProvider{
	....
	&workflow.ServiceProvider{},
    }
}

1.2 启动goravel项目

go run . 

发布资源

默认将发布2类资源，一是配置文件，而是数据表迁移

go run . artisan vendor:publish --package=github.com/hulutech-web/goravel-workflow

1. 模型映射资源config/workflow.go

config := facades.Config()
	config.Add("workflow", map[string]any{
		"Dept": "Department", //部门关联应用中的模型
		"Emp":  "User",       //员工关联应用中的模型
	})

TIP

解释：如果在集成前已经定义了有关用户与部门模型，那么请在该配置中进行修改，关联关系为1:1关系。

2. 数据库迁移，goravel/database

流程框架将发布的迁移sql文件，seeder填充文件，发布到该路径下，请根据需要自行修改。

3. 运行数据库迁移

user模型与emp模型保持1:1关联。 databases/seeders/database_seeder.go

// Run executes the seeder logic.
func (s *DatabaseSeeder) Run() error {
	return facades.Seeder().Call([]seeder.Seeder{
		&WorkflowDatabaseSeeder{},
		&UserSeeder{},
	})
}

go run . artisan migrate

goravel命令将创建有关流程框架的所有表结构，默认带有测试数据，如需要查看测试数据，请运行

go run . artisan migrate:fresh --seed

路由

默认采用api路由，请在集成时注意路由冲突问题，并酌情修改。详情路由

表单验证规则

package rules

import (
	"github.com/goravel/framework/contracts/validation"
	"strings"
)

type AlphaRule struct {
}

// Signature The name of the rule.
func (receiver *AlphaRule) Signature() string {
	return "alpha_rule"
}

// Passes Determine if the validation rule passes.
func (receiver *AlphaRule) Passes(data validation.Data, val any, options ...any) bool {
	if val == "" {
		return true
	}
	for _, ch := range []rune(val.(string)) {
		if !('a' <= ch && ch <= 'z') && !('A' <= ch && ch <= 'Z') && !(strings.Contains("_", string(ch))) {
			return false
		}
	}
	return true
}

// Message Get the validation error message.
func (receiver *AlphaRule) Message() string {
	return "字符 :attribute 必须是英文字符或者包含下划线"
}

goravel命令

go run . artisan make:rule AlphaRule

并将该代码复制到规则文件中。

注册规则

在app/providers/validation_service_provider.go中注册该规则。

...
func (receiver *ValidationServiceProvider) rules() []validation.Rule {
  return []validation.Rule{
    &rules.AlphaRule{},
  }
}
...

员工绑定模型(user)

user模型课参考如下，其中Name,WorkNo,Password必需，可根据需要自行扩展

type User struct {
	orm.Model
	Name     string    `gorm:"column:name;type:varchar(255);not null" form:"name" json:"name"`
	Avatar   string    `gorm:"column:avatar;type:varchar(255);not null" form:"avatar" json:"avatar"`
	WorkNo   string    `gorm:"column:workno;not null;unique_index:users_workno_unique" json:"workno" form:"workno"`
	Password string    `gorm:"column:password;type:varchar(255);not null" form:"password" json:"password"`
	Email    string    `gorm:"column:email;type:varchar(255);not null" form:"email" json:"email"`
	Mobile   string    `gorm:"column:mobile;type:varchar(255);not null" form:"mobile" json:"mobile"`
	Gender   int       `gorm:"column:gender;type:varchar(255);not null" form:"gender" json:"gender"`
	State    int       `gorm:"column:state;type:varchar(255);not null" form:"state" json:"state"`
	Workflow *Workflow `gorm:"-"`
	orm.SoftDeletes
}

为了方便的集成，您可以在api.go路由下，创建资源路由，并在控制器中编写用户列表方法。

• api.go
  参考

  facades.Route().Middleware(middleware.Jwt()).Prefix("/api").Group(func(router route.Router) {
    	userCtrl := controllers.NewUserController()
    	router.Resource("/user", userCtrl)
    })
  

• user_controller.go中，查询用户信息

import httpfacades "github.com/hulutech-web/http_result"

func (r *UserController) Index(ctx http.Context) http.Response {
	users := []models.User{}
	queries := ctx.Request().Queries()
	result, _ := httpfacades.NewResult(ctx).SearchByParams(queries, []string{"excepts"}...).ResultPagination(&users, []string{"Dept"}...)
	return result
}

• 系统内置了emp模型，并提供了绑定方法，方便快速实现用户与员工的绑定