spirng代码规范总结

spirng代码规范总结    

     1 代码要简洁、干净。表现为这么几点：（1）尽量不要写注释，而是把代码写的尽量一目了然，让别人在看代码的时候不需要通过注释而只是通过代码就知道这些代码的含义。（2）对于以前的一些废代码我们之前有时候的做法是将其注释掉，这里奉行的做法是直接删掉，不需要害怕需要恢复时找不到之前的代码，因为我们有code管理的东西如git。所以能很方便的进行恢复。（3）代码如此，xml文件也同样如此。（4）类文件中有时候会有一些多余的import，你会看到Eclipse有一个黄色的提示，这些我们需要将其清理干净，同样的对于一些没有使用过的变量也是一样。
    

      2 命名需要规范。表现在：（1）变量名不能用类型来命名，如 iUserId，这种是不对的。（2）不能用C的风格来命名，如UFWItem，还有变量名是不能大写开头的。关于这个命名规范我在后面会给出一个更加详细的说明文档。
     

     3 测试的东西不要放在代码里，需要的话就放在test那个模块

     4 我们需要将我们的Eclipse的Encoding设置为UTF-8，设置Eclipse为UTF-8是一个全局的，即以后所有用Eclipse编辑的Code都会是UTF-8的编码。我们可以只为Project设置Encoding为UTF-8.Encoding统一这是非常重要的，所以都check一下看看是否已经是设置成了UTF-8，如果没有，请按下面的指示进行设置：

          （1）设置Eclipse为UTF-8. Window -> Preferences会打开Preferences对话框，然后Genera -> Editors -> Text Editors -> spelling.这时候我们就能看到Spelling的选项，其中就有一个Encoding，默认的是GBK，我们选中Other然后选择UTF-8.
          

          （2）设置Project的编码格式为UTF-8

               Project -> Properties或者File -> Properties会看到一个Properties For ***Project对话框。选择Resource就会出现Resource的面板，然后我们将其中的Text file Encoding设置为UTF-8.

           

     5 在代码里不应该出现硬代码。像下面图所示这种就是硬代码，我们需要将其配置在项目的配置文件里。

     

     6 在代码的Catch块中应该说是任何地方都不应该存在这种直接print的情况，如下面图示：

     

     上图中e.printStackTrace不能这样，如果需要打印日志我们可以使用Logger机制。

     还有// TODO: handle exception 如果我们有对异常进行处理那么我们最后都需要将这个删掉。TODO是用来标志某些地方尚还需要继续完善的，所以当我们的工作已经做完了的时候就把这个给去掉。