巧用JBuilderX代码美化东西

副标题#e#

引言

代码编写气势气魄主要包罗变量、要领、类等语言实体的定名和代码排版机关两方面。评价代码质量的坎坷不只取决于算法和数据布局，代码排版机关也是一个不行或缺的方面。跟着现代软件局限的扩大，团队开拓在所不免，好的代码编写气势气魄加强了代码可读性和维护性，提高了团队协作的效率。

JBuilder被誉为java航空母舰级的开拓东西，今朝的最高版本是10，定名为JBuilderX。本文着重先容如安在JBuilderX中美化代码，名目化代码排版机关，同时还将先容JBuilderX加快代码编写的一些实用能力。

代码美化东西

市面上已经有许多代码美化的东西软件，较量著名的有Indent、astyle、jalopy、SourceFormatX 等，个中SourceFormatX是一个多语言的代码美化东西。但这些东西没有和开拓东西很好的集成，且不易操纵，成果也不足强大或不针对专门的java语言。JBuildeX集成了一个强大的代码排版机关名目化东西，在您编写好代码后，可以通过它来美化您的代码。它可以对代码做以下7个方面的名目化事情：

1) 缩进：java代码以"{}"分另外差异代码子域，里层的域比外层的域需要缩进一些，以使代码有条理感，通过该东西可以界说里层相对外层代码缩进的空格数，Tab键对应的空格数;

2) 分行：类界说、要领界说以及节制代码,如if..else, while ,try.. catch等都有对应的"{}"，以组织其代码区域，您可以指定"{"和"}"是否另起一行;

3) 空格：指定在操纵符、小括号"（）"、中括号"[]"、分号";"等标记和操纵代码之间是否需要空格;

4) 空行：答允您指定代码里哪儿需要插手空行以及空行数，使差异的代码域之间区分得越发清晰;

5) 换行对齐：指定代码行的最大列数，高出列数的代码行会被智能拆分成多行，只有包括了操纵符或逗号的代码行才可以被换行。您可以指定换行点是在这些标记前面照旧后头，同时，您还可以设定换行后多行的对齐方法;

6) 代码生陈法则：节制自动事件句柄、变量可视域及javaBean实例化的代码生陈法则;

7) import代码优化法则：节制类中import代码引入的包和类如何生成及它们排序的先后顺序，以优化import代码段。

建设java工程后，在主窗口左上角的工程面板的工程文件（xxx.jpx）上点击鼠标右键，按以下操纵调出代码美化东西配置界面：

选择Properties->在弹出窗口左边的树中选择Fomatting,获得如图1的操纵窗口界面：

图1. 代码名目化窗口

窗口的右边有7个页标签，别离对应上面所谈到的7个方面的代码配置。每一个配置页左边对应若干个配置项，右边是代码名目化的预览结果，这样您就可以即时相识配置项是如何影响代码的排版机关。下一节我将以详细的例子示范如何利用这个代码美化东西。

#p#副标题#e#

利用代码美化东西美化代码

下面是一个简朴的java类代码，其成果很是简朴，是将两个双精度数按要求相加或相减，再将其功效值四舍五入为一个整数，该例子只是为了演示代码名目化，您大可不必追究代码的成果。

package format;
import java.lang.Math;
import java.util.*;
public class FormatSample {
private int i;
private int j;
public FormatSample() {}
public long add(double i,double j,boolean isAdd){
double k ;
if(isAdd){k=i+j;}
else{k=i-j;}
System.out.println("today is "+((new Date()).toString())+"the operation of"+i+(isAdd?"+":"-"+"")+j+" equals "+k);}}

这段代码的排版机关很是差，固然只是一小段，也会给阅读者造成晕旋结果。这一小段代码在机关上的症结可以归纳为以下几项：

1)里外层代码域处于沟通列，没有用缩进形成条理机关

2) if..else的代码块的大括号"{"及"}"和代码处于同一行

3) 操纵符和操纵数之间没有用空格分隔

4) import代码块 和 class界说以及要领和要领代码块之间没有空行脱离，挤成一团

5) System.out.println那行太长，在IDE窗口中需要移动程度转动条才可以看到埋没的代码

6) import 的代码行引入了过多的类，FormatSample类只需要引入java.util.Date这个类就可以了。

对以上这些排版机关缺陷举办批改我们但愿获得了以下版本的的代码：

package format;import java.util.Date;public class FormatSample
{
　 private int i;
　 private int j;
　 public FormatSample()
　 {
　 }
　 public long add(double i, double j, boolean isAdd)
　 {
　　 double k;
　　 if (isAdd)
　　 {
　　　 k = i + j;
　　 }
　　 else
　　 {
　　　 k = i - j;
　　 }
　　 System.out.println("today is " + ( (new Date()).toString())
　　　　　　　　　 + "the operation of" + i
　　　　　　　　　 + (isAdd ? "+" : "-" + "") + j + " equals " + k);
　　 return Math.round(k);
　 }
}

#p#分页标题#e#

我们通过以下配置步调来名目化FormatSample类的代码，在配置代码名目化后，必需在代码页面中点击鼠标右键，选择Format All按钮名目化代码。你也可以在项目窗口的树中选择<Project Source>项，并点击右键，选择Format package" <Project Source>"…来名目化整个项目标所有代码：

图2. 名目化整个项目标代码

#p#副标题#e#

1) 使代码里外层代码区域形成层级缩进的机关

切换到代码美化东西配置界面的Basic标签页，配置block indent的缩进空格数，默认的里层代码比外层代码缩进2个空格，这对付利用拉丁语系的国度是较量适合的，对付利用汉语的编程者应用调成4个空格会更好一些，因为2个空格才对应一个汉字的长度。

2) 使代码块的正反大括号"｛"和"｝"安排在新行中，而且使对应的大括号在列上对齐。

切换到Blocks的标签面，将左边树的所有复选框都钩选，这样所有大括号城市另起一行，并且成对的大括号会在列上对齐。通过在列上对应的成对大括号，我们可以或许很是容易分别出代码块。将所有大括号（除数组初始化的大括号外）另起一行安排比不另起一行安排的代码可读性更强。我认为在下面的两种代码机关形式中，右边的代码比左边的代码具有更好的可读性：

if(true){
　/**do sth*/
}
else{
　/**do sth*/
}
if(true)
{
　/**do sth*/
}
else
{
　/**do sth*/
}

3) 操纵符和操纵数之间插入空格

切换到Spaces标签页，该页面左边选项树从上到下分为5个配置项组，别离配置代码中分号";"前后的空格，小括号"（）"和要领名、要害词及内里嵌套小括号之间的空格，逗号","前后的空格，小括号和中括号和其包括的代码之间的间距空格，归为Others的一些杂项空格项目标配置。通过点击配置项前的复选框，右边的预览窗口将给出配置后的代码结果。下图是我们代码名目化所用的配置：

图3. 空格配置界面

4) 在代码差异部门之间插入空行

java语言的布局化对比于C，Pascal等其他语言的布局都要清晰严谨。代码组织布局按先后顺序依次是包界说、引用类加载、类声明、全局变量声明和要领声明。可以在这些差异部门的代码间插入空行，使代码差异部门看起来一目了然。空行的配置在Blank Lines的标签页中，在这个页面中你不单可以配置在哪儿插入空行，还可以配置插入空行的数目。如您可以在import代码部门和类界说代码部门之间插手两个空行，全局变量界说代码之间可不插入空行，要领和要领之间插入一个空行。

5) 让太长的代码行自动换行

代码编写窗口巨细有限，太长的代码行需要移动程度转动条才可以查察。将代码窗口转动到右边时，左边的代码又看不到了，造成"神龙见首不见尾"的现象，严重影响代码的可读性和阅读效率。JBuilderX在Fomatting窗口的Wrapping标签页中提供了智能换行的配置成果。您可以在Wrap after column中配置代码行的长度，还可以配置代码行换行的依据标记。代码行中的逗号，操纵符是代码行自动换行的依据符。

JBuilderX在自动换行中提供的另一个精制的成果：可以指定单行拆分成多行后，这些行的对齐方法，你可以指定多行头部和"("对齐或和"="对齐，发起将两者都钩选。名目化后，例子中的System.out.println("…")代码行酿成了三行，后两行代码和"（"对齐。

6) 优化import代码块

切换到Formatting窗口的最后一个Imports标签页，对import代码块做优化配置。JVM会自动加载java.lang.*包，所以例子中的import java.lang.Math;是多余的，另外类中只用到java.util.*包中的一个类java.util.Date，无需引入包中的其他类。JBuilderX的import代码优化成果答允你配置一个阈值，在当前类中引用到包中的类数目小于这个阈值时，它就会将包名后的"*"替换成详细的类名。您也可以通过钩选配置页面中的Always import classes复选框使import在任何时候都将包后的"*"替换成详细的类名。（留意：通过在代码窗口中点击右键选择Format All名目化代码，不执行import代码的优化配置，你可以在代码窗口中按Ctrl+I快捷键或用图2的操纵步调来执行import代码的优化）

#p#副标题#e#

其他加快代码编写及排版机关的能力

1) 用模板加快代码的录入，担保排版机关上的一致性

#p#分页标题#e#

JBuilderX提供了富厚的代码模板，通过代码模板可以快速地录入常用的代码块。JBuildeX的代码模板库提供了大量的常用的代码模板，代码模板库答允你对代码模板举办维护：对已有模板举办变动或新增自界说的代码模板。您可以通过以下操纵调出代码模板库：Tools->Preferences….->选择弹出窗口左边树的Templates,如：

图4. 代码模板维护窗口

您可以在这个界面中对java,HTML以及其他通用的代码模板举办维护，一个模板界说包罗3项内容：模板名字、模板描写以及模板界说体。如图4中的if..else模板的名字是ife,描写为if else,模板体为：

if (|) { |}else { |}

个中字符"|"是代码模板挪用后光标地址的位置，光标停在第1个"|"处，可以按Tab键移动光标到差异的"|" 处。在代码编辑窗口按Ctrl+J再键入模板的名字就可以挪用模板代码，模板ife调出后在编辑器中的显示结果如下图：

图5. 按Ctrl+J挪用代码模板（再按Enter选择）

图6. 代码模板ife的编辑结果图

2) 同步编辑模式

假如一段代码中一个标识符呈现多次，当需要变动这个标识符时，同步编辑模式可以给您带来极大的利便。如下面是一段遍历Iterator的代码：

Iterator iter = .iterator();
while (iter.hasNext())
{
　 Object item = (Object)iter.next();
}

假如您需要将iter名字改为myIter，你可以先选中这段代码，然后按Ctrl+Shift+J,这个代码段就进入了同步编辑模式,在同步编辑模式下只要变动个中任何一个标识符其他沟通的标识符也会同步变动。在编辑窗口中，这段代码显示结果如下：

图7. 同步编辑模式

这段代码中iter变量呈现了3次，第一个iter呈选中状态，您只要将任何一个变动为myIter，其他的iter也随着变动过来。假如你想退出同步编辑模式，请点击编辑窗口左边标有行数栏中的 按钮。

3) 代码段整体移动

在一般的编辑器中（如UltraEdit，EditPlus）都提供了整段代码整体左移和右移的操纵，操纵的方法是选中需要移动的代码段，然后按Tab向右移或按Shift+Tab向左移。JBuilderX也提供了这个成果，但操纵键略有差异，向右移的按键是Ctrl+Shift+I,向左移可以通过Shift+Tab或Ctrl+Shift+U两种操纵方法来实现。代码整体移动对付缩进的排版出格有辅佐。

总结

JBuilderX是一个成果强大的java智能开拓情况，它提供的代码美化东西可以对代码举办高效的美化排版机关，大大地减轻了开拓人员代码排版机关的事情，担保了团队差异成员间编辑代码机关气势气魄的一致性。利用好这个东西必将给您的java开拓带来效率上的晋升和质量上的优化。