这取决于你自己的风格和规则,在我的公司,我们是这样开发我们的项目的:
- 配置由环境变量决定,因此我们有一个
company/envs/project.sh 文件,必须在之前服务(图片中的项目之外)对其进行评估。
- 我们添加了一个
zscripts 文件夹,其中包含所有额外的脚本,例如添加用户或发布帖子。仅用于调试建议。
- 数据模型(实体)位于名为
project/models 的包中。
- 所有控制器和视图(HTML 模板)都归类为“应用程序”或“模块”。我们使用 REST 路径作为主组分隔符,因此路径
/dogs 转到包 project/apps/dogs 和 /cats 到 project/apps/cats。
- 经理位于项目根
project/manager 的单独包中。
- 静态文件(.css、.png、.js 等)位于
project/static/[app/]。有时需要有可选的[app/] 文件夹,但仅当两个应用程序具有仪表板或文件名冲突时才会发生。大多数情况下,您不需要将[app/] 用于静态资源。
经理
我们称之为管理器,一个包含纯函数的包,可以帮助应用程序执行其任务,例如数据库、缓存、S3 存储等。我们在开始监听之前初始化每个调用 package.Startup() 的管理器,并最终确定程序中断时调用package.Finalize()。
经理的例子可以是project/cache/cache.go:
type Config struct {
RedisURL string `envconfig:"redis_url"`
}
var config Config
var client *redis.Client
func Startup(c Config) error {
config = c
client, err := redis.Dial(c.RedisURL)
return err
}
func Set(k,v string) error {
return client.Set(k, v)
}
在 main.go(或 your_thing_test.go)中:
var spec cache.Config
envconfig.Process("project", &spec)
cache.Startup(spec)
在应用程序(或模块)中:
func SetCacheHandler(_ http.ResponseWriter, _ *http.Request){
cache.Set("this", "rocks")
}
模块
模块是与其他模块隔离的视图和控制器的容器,使用我们的配置,我建议不要在模块之间创建依赖关系。模块也称为应用程序。
每个模块使用路由器、子路由器或您的框架提供的配置其路由,例如(文件project/apps/dogs/configure.go):
func Configure(e *echo.Echo) {
e.Get("/dogs", List)
}
然后,所有处理程序都住在project/apps/dogs/handlers.go:
// List outputs a dog list of all stored specimen.
func List(c *echo.Context) error {
// Note the use of models.Xyz
var res := make([]models.Dog, 0) // A little trick to not return nil.
err := store.FindAll("dogs", nil, &res) // Call manager to find all dogs.
// handle error ...
return c.JSON(200, res) // Output the dogs.
}
最后你在 main 中(或在测试中)配置应用程序:
e := echo.New()
dogs.Configure(e)
// more apps
e.Run(":8080")
注意:对于视图,您可以将它们添加到project/apps/<name>/views 文件夹并使用相同的功能对其进行配置。
其他
有时我们还会添加一个project/constants 和一个project/utils 包。
这是它的样子:
请注意,在上面的示例中,templates 与应用程序分开,那是因为它是占位符,目录是空的。
希望它有用。来自墨西哥的问候:D.