Java

MyEclipse生成get/set注释

    通常我们把 JavaBean 的字段注释（文档注释格式）写在字段上面，但生成的Get/Set方法不会添加字段注释，通过修改Eclipse源码可解决。效果如下：

 

	/**
	 * 序号
	 */
	private int id;

	/**  
	 * 获取序号  
	 * @return id 序号
	 */
	public int getId() {
		return this.id;
	}

	/**  
	 * 设置 序号  
	 * @param id 序号
	 */
	public void setId(int id) {
		this.id = id;
	}

解决方案如下：

 

通过反编译，修改MyEclipse2013的安装文件夹plugins目录下的org.eclipse.jdt.ui_3.8.2.v20130107-165834.jar包中的org.eclipse.jdt.internal.corext.codemanipulation.GetterSetterUtil类
下的getSetterStub及getGetterStub方法，来实现生成getter/setter时，注释使用成员变量的注释（如果成员变量的注释（文档注释格式）有的话）。在选择了生成getter/setter时需要生成code comment的话，如果没有成员变量的注释则使用注释模板生成。

一、在MyEclipse2013中新建一个工程，在src目录下新建org.eclipse.jdt.internal.corext.codemanipulation包，拷贝反编译出的GetterSetterUtil.java类到该目录下，会有报错发生，主要是一些方法和类找不到的问题。现在在工程名上右键新建一个名称为libs的文件夹，从MyEclipse2013的安装文件夹plugins下拷贝

org.eclipse.jdt.core_3.8.3.v20130121-145325.jar、

org.eclipse.jdt.ui_3.8.2.v20130107-165834.jar、

org.eclipse.equinox.common_3.6.100.v20120522-1841.jar三个jar文件到libs目录，并添加到构建路径。

打开GetterSetterUtil类会看到如下错误，在报错处鼠标悬停几秒，会出现提示对话框，选择Organize import即可修复错误。现在已经解决所以报错问题。下面修改源代码：

二、修改源代码：

getSetterStub函数修改的地方为：

 

.......  
        IJavaProject project = field.getJavaProject();  
        //start  
        String accessorName = NamingConventions.removePrefixAndSuffixForFieldName(project, fieldName, field.getFlags());  
        //end  
        String argname = StubUtility.suggestArgumentName(project, accessorName,EMPTY);  
.......  
        if (addComments) {  
            String comment = CodeGeneration.getSetterComment(  
                    field.getCompilationUnit(),  
                    parentType.getTypeQualifiedName('.'),  
                    setterName,   
                    field.getElementName(),   
                    typeName,   
                    argname,   
                    accessorName,  
                    lineDelim);  
            //start  
            ISourceRange sr = field.getJavadocRange();  
            if (null != sr) {  
                String filedComment = field.getSource();  
                filedComment = filedComment.substring(0, sr.getLength());  
                filedComment = filedComment.replaceAll("[\n,\r,*,/, ,\t]", "");  
  
                comment = comment.replaceFirst(field.getElementName(), filedComment);  
  
                int i = comment.lastIndexOf(field.getElementName());  
                int j = getCount(comment, field.getElementName());  
                if (i != -1 && j >= 2) {  
                    comment = comment.substring(0, i) + filedComment + comment.substring(i + field.getElementName().length());  
                }  
            }  
            //end  
            if (comment != null) {  
                buf.append(comment);  
                buf.append(lineDelim);  
            }  
.......  

 getGetterStub函数修改的地方为：

 

 

.......
		String typeName = Signature.toString(field.getTypeSignature());
		//start
		String accessorName = NamingConventions.removePrefixAndSuffixForFieldName(field.getJavaProject(), fieldName, field.getFlags());
		//end
		String lineDelim = "\n";
		StringBuffer buf = new StringBuffer();
		if (addComments) {
			//field.getCompilationUnit() 得到当前类文件内容,就是要get,set的东西
			//parentType.getTypeQualifiedName('.') 得到类名
			//getterName 拼出get的方法名
			//field.getElementName() 得到字段名
			//typeName 类型
			String comment = CodeGeneration.getGetterComment(
							field.getCompilationUnit(),
							parentType.getTypeQualifiedName('.'),
							getterName,
							field.getElementName(),
							typeName, 
							accessorName, 
							lineDelim);
			//start
			ISourceRange sr = field.getJavadocRange();
			if (null != sr) {
				String filedComment = field.getSource();
				filedComment = filedComment.substring(0, sr.getLength());
				filedComment = filedComment.replaceAll("[\n,\r,*,/, ,\t]", "");
				comment = comment.replaceFirst(field.getElementName(),
						filedComment);
				int i = comment.lastIndexOf(field.getElementName());
				int j = getCount(comment, field.getElementName());
				if (i != -1 && j >= 2) {
					comment = comment.substring(0, i)
							+ filedComment
							+ comment.substring(i
									+ field.getElementName().length());
				}
			}
			//end
.....

 新添加一个名称为getCount的方法，代码如下：

 

 

	//start
	private static int getCount(String str, String sign) {
		// 查找某一字符串中str，特定子串sign的出现次数
		if (str == null)
			return 0;
		double i = str.length();
		str = str.replaceAll(sign, "");// 将串中的字符sign替换成""
		return (int) (i - str.length()) / sign.length();
	}
	//end

编译器不报错的时候，在bin目录下拷贝GetterSetterUtil.class文件，使用zip或rar压缩软件打开jar包，替换org.eclipse.jdt.ui_3.8.2.v20130107-165834.jar包中的org.eclipse.jdt.internal.corext.codemanipulation目录下的同名文件。

三、配置MyEclipse2013

 

四、效果

 

 

在JavaBean中使用Alt+Shift+Z快捷键调出get/set方法生成面板，如图所示，点击确定按钮后即可看到效果。