【问题标题】:Automatically generated code fails CheckStyle standards (jHipster)自动生成的代码未通过 CheckStyle 标准 (jHipster)
【发布时间】:2017-07-25 09:02:28
【问题描述】:

我已经开始在最近的一个项目中使用 jHipster,这是一个工具,您可以使用它使用 Spring Boot 后端自动生成 REST api 应用程序的完整堆栈。这应该可以节省大量编写样板代码的时间...

不幸的是,在我的工作中,我们需要以一组 CheckStyle 规则的形式遵守编码标准。任何不遵守这些规则的代码都会导致构建失败。我目前遇到的是这个自动生成的代码在很多地方都没有通过 CheckStyle 规则。目前我正在通过手动搜索修复每个问题的代码来处理这个问题。

我不禁在脑海中感到一定有更好的方法来做到这一点,例如:

  • 配置 IDE (intelliJ) 以确保生成的代码符合 CheckStyle 规则。当直接在 IDE 中编码时,这当然是可能的。
  • 在自动生成代码之前配置 jHipster 以了解 CheckStyle 规则。
  • 之后运行脚本可以自动修复任何 CheckStyle 故障。 (我相信这一定是可行的!)

如果有人知道解决此问题的最佳方法可能是什么,以及过去是否有人做过类似的事情,我会很高兴。

【问题讨论】:

    标签: java spring intellij-idea jhipster checkstyle


    【解决方案1】:

    抑制所有自动生成的文件的违规行为,因为它超出了您的控制范围。
    http://checkstyle.sourceforge.net/config_filters.html#SuppressionFilter

    如果您的文件中有自动生成的代码以及您手动维护的非生成代码,请使用注释抑制。
    http://checkstyle.sourceforge.net/config_filters.html#SuppressionCommentFilter

    你不应该为这个确切目的编写你不写的代码样式,你不是在编写它,并且某些实用程序是并且它不是根据你的样式规范构建的。如果您再次生成文件,它将撤消您所做的任何手动更改。

    【讨论】:

    • 感谢您的回复。这绝对是我正在考虑的事情,我同意你的看法。我将尝试在我们的下一个 sprint 回顾中提出这个问题,看看我是否能说服我的同事。
    猜你喜欢
    • 2015-11-24
    • 2011-02-27
    • 2021-02-01
    • 1970-01-01
    • 2010-10-04
    • 1970-01-01
    • 2014-03-25
    • 1970-01-01
    • 2016-07-20
    相关资源
    最近更新 更多