46.5.1 命名

你应该确保为你的starter提供一个合适的命名空间。即使使用一个不同的Maven groupId,模块名也不要以spring-boot作为开头。未来我们可能会为你正在做的自动配置提供官方支持。

这里是经验之谈:你应该在starter之后命名一个组合模块。例如,假设你正在为“acme”创建一个starter,命名自动配置模块为acme-spring-boot-autoconfigure,命名starter为acme-spring-boot-starter。如果只有一个模块结合它们,通常会使用acme-spring-boot-starter

此外,如果你的starter提供配置key,需要为它们提供一个唯一的命名空间,特别是不要使用Spring Boot的命名空间(比如,servermanagementspring等)。我们可能会在将来修改它们。如果你使用相同的命名空间,这可能会破坏你的模块。

确保触发meta-data生成,这样IDE辅助也就可以用于你的key了。你可能想检查生成的元数据(META-INF/spring-configuration-metadata.json)以确保key被正确的文档化。

最后更新于