2. 程式人生 > >Eclipse get/set方法自動加上欄位註釋

Eclipse get/set方法自動加上欄位註釋

阿新 • • 發佈：2018-12-14

編碼的時候通常要用到 JavaBean ，而在我們經常把註釋寫在欄位上面，但生成的Get/Set方法不會生成，通過修改Eclipse原始碼可解決，直接上例子:

    /** 
     * 員工ID 
     */  
    private String userid;  
    /** 
     * 獲取員工ID 
     * @return userid 員工ID 
     */  
    public String getUserid() {  
        return userid;  
    }  
    /** 
     * 設定員工ID 
     * @param userid 員工ID 
     */  
    public void setUserid(String userid) {  
        this.userid = userid;  
    }

關閉eclipse 找到Eclipse中Jar包：org.eclipse.jdt.ui_*.jar，進行備份 找到org.eclipse.jdt.internal.corext.codemanipulation.GetterSetterUtil.class 直接用附件中的class檔案進行替換，重啟Eclipse 設定註釋風格： Window->Preferences->Java->CodeStyle->Code Templates->Comments->Getters/Setters Getters: /**

  • 獲取${bare_field_name}
  • @return ${bare_field_name} ${bare_field_name} / Setters: /
    *
  • 設定${bare_field_name}
  • @param ${bare_field_name} ${bare_field_name} */ 注意：生成Get/Set方法時勾選上Generate method comments OK，成功。

在eclipse4.2上測試通過。

替換GetterSetterUtil.class的原碼:

package org.eclipse.jdt.internal.corext.codemanipulation;
 
import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.core.*;
import org.eclipse.jdt.core.dom.*;
import org.eclipse.jdt.core.dom.rewrite.ASTRewrite;
import org.eclipse.jdt.internal.corext.dom.ASTNodes;
import org.eclipse.jdt.internal.corext.util.JavaModelUtil;
import org.eclipse.jdt.internal.corext.util.JdtFlags;
import org.eclipse.jdt.ui.CodeGeneration;
 
/**
 * @author 
 
[email protected]
 */
public class GetterSetterUtil {
 
	private static final String EMPTY[] = new String[0];
 
	private GetterSetterUtil() {
	}
 
	public static String getGetterName(IField field, String excludedNames[])
			throws JavaModelException {
		boolean useIs = StubUtility.useIsForBooleanGetters(field
				.getJavaProject());
		return getGetterName(field, excludedNames, useIs);
	}
 
	private static String getGetterName(IField field, String excludedNames[],
			boolean useIsForBoolGetters) throws JavaModelException {
		if (excludedNames == null)
			excludedNames = EMPTY;
		return getGetterName(field.getJavaProject(), field.getElementName(),
				field.getFlags(), useIsForBoolGetters
						&& JavaModelUtil.isBoolean(field), excludedNames);
	}
 
	public static String getGetterName(IVariableBinding variableType,
			IJavaProject project, String excludedNames[], boolean isBoolean) {
		boolean useIs = StubUtility.useIsForBooleanGetters(project)
				&& isBoolean;
		return getGetterName(project, variableType.getName(), variableType
				.getModifiers(), useIs, excludedNames);
	}
 
	public static String getGetterName(IJavaProject project, String fieldName,
			int flags, boolean isBoolean, String excludedNames[]) {
		return NamingConventions.suggestGetterName(project, fieldName, flags,
				isBoolean, excludedNames);
	}
 
	public static String getSetterName(IVariableBinding variableType,
			IJavaProject project, String excludedNames[], boolean isBoolean) {
		return getSetterName(project, variableType.getName(), variableType
				.getModifiers(), isBoolean, excludedNames);
	}
 
	public static String getSetterName(IJavaProject project, String fieldName,
			int flags, boolean isBoolean, String excludedNames[]) {
		return NamingConventions.suggestSetterName(project, fieldName, flags,
				isBoolean, excludedNames);
	}
 
	public static String getSetterName(IField field, String excludedNames[])
			throws JavaModelException {
		if (excludedNames == null)
			excludedNames = EMPTY;
		return NamingConventions.suggestSetterName(field.getJavaProject(),
				field.getElementName(), field.getFlags(), JavaModelUtil
						.isBoolean(field), excludedNames);
	}
 
	public static IMethod getGetter(IField field) throws JavaModelException {
		String getterName = getGetterName(field, EMPTY, true);
		IMethod primaryCandidate = JavaModelUtil.findMethod(getterName,
				new String[0], false, field.getDeclaringType());
		if (!JavaModelUtil.isBoolean(field) || primaryCandidate != null
				&& primaryCandidate.exists()) {
			return primaryCandidate;
		} else {
			String secondCandidateName = getGetterName(field, EMPTY, false);
			return JavaModelUtil.findMethod(secondCandidateName, new String[0],
					false, field.getDeclaringType());
		}
	}
 
	public static IMethod getSetter(IField field) throws JavaModelException {
		String args[] = { field.getTypeSignature() };
		return JavaModelUtil.findMethod(getSetterName(field, EMPTY), args,
				false, field.getDeclaringType());
	}
 
	/**
	 * Set方法註釋
	 * @param field
	 * @param setterName
	 * @param addComments
	 * @param flags
	 * @return
	 * @throws CoreException
	 */
	public static String getSetterStub(IField field, String setterName,
			boolean addComments, int flags) throws CoreException {
 
		String fieldName = field.getElementName();
		IType parentType = field.getDeclaringType();
		String returnSig = field.getTypeSignature();
		String typeName = Signature.toString(returnSig);
		IJavaProject project = field.getJavaProject();
		String accessorName = NamingConventions.removePrefixAndSuffixForFieldName(project, fieldName, field.getFlags());
		String argname = StubUtility.suggestArgumentName(project, accessorName,EMPTY);
		boolean isStatic = Flags.isStatic(flags);
		boolean isSync = Flags.isSynchronized(flags);
		boolean isFinal = Flags.isFinal(flags);
		String lineDelim = "\n";
		StringBuffer buf = new StringBuffer();
		if (addComments) {
			String comment = CodeGeneration.getSetterComment(
					field.getCompilationUnit(),
					parentType.getTypeQualifiedName('.'),
					setterName, 
					field.getElementName(), 
					typeName, 
					argname, 
					accessorName,
					lineDelim);
			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());
				}
			}
 
			if (comment != null) {
				buf.append(comment);
				buf.append(lineDelim);
			}
		}
		buf.append(JdtFlags.getVisibilityString(flags));
		buf.append(' ');
		if (isStatic)
			buf.append("static ");
		if (isSync)
			buf.append("synchronized ");
		if (isFinal)
			buf.append("final ");
		buf.append("void ");
		buf.append(setterName);
		buf.append('(');
		buf.append(typeName);
		buf.append(' ');
		buf.append(argname);
		buf.append(") {");
		buf.append(lineDelim);
		boolean useThis = StubUtility.useThisForFieldAccess(project);
		if (argname.equals(fieldName) || useThis && !isStatic)
			if (isStatic)
				fieldName = parentType.getElementName() + '.' + fieldName;
			else
				fieldName = "this." + fieldName;
		String body = CodeGeneration.getSetterMethodBodyContent(field
				.getCompilationUnit(), parentType.getTypeQualifiedName('.'),
				setterName, fieldName, argname, lineDelim);
		if (body != null)
			buf.append(body);
		buf.append("}");
		buf.append(lineDelim);
		return buf.toString();
	
	}
 
	/**
	 * Get方法註釋
	 * @param field
	 * @param getterName
	 * @param addComments
	 * @param flags
	 * @return
	 * @throws CoreException
	 */
 
	public static String getGetterStub(IField field, String getterName,
			boolean addComments, int flags) throws CoreException {
		String fieldName = field.getElementName();
		IType parentType = field.getDeclaringType();
		boolean isStatic = Flags.isStatic(flags);
		boolean isSync = Flags.isSynchronized(flags);
		boolean isFinal = Flags.isFinal(flags);
		String typeName = Signature.toString(field.getTypeSignature());
		String accessorName = NamingConventions.removePrefixAndSuffixForFieldName(field.getJavaProject(), fieldName, field.getFlags());
		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);
			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());
				  }
			  }
			  
			if (comment != null) {
				buf.append(comment);
				buf.append(lineDelim);
			}
		}
		buf.append(JdtFlags.getVisibilityString(flags));
		buf.append(' ');
		if (isStatic)
			buf.append("static ");
		if (isSync)
			buf.append("synchronized ");
		if (isFinal)
			buf.append("final ");
		buf.append(typeName);
		buf.append(' ');
		buf.append(getterName);
		buf.append("() {");
		buf.append(lineDelim);
		boolean useThis = StubUtility.useThisForFieldAccess(field.getJavaProject());
		if (useThis && !isStatic)
			fieldName = "this." + fieldName;
		String body = CodeGeneration.getGetterMethodBodyContent(field.getCompilationUnit(), parentType.getTypeQualifiedName('.'), getterName, fieldName, lineDelim);
		if (body != null)
			buf.append(body);
		buf.append("}");
		buf.append(lineDelim);
		return buf.toString();
	}
 
	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();
	}
 
	public static Expression getAssignedValue(ASTNode node,
			ASTRewrite astRewrite, Expression getterExpression,
			ITypeBinding variableType, boolean is50OrHigher) {
		org.eclipse.jdt.core.dom.InfixExpression.Operator op = null;
		AST ast = astRewrite.getAST();
		if (isNotInBlock(node))
			return null;
		if (node.getNodeType() == 7) {
			Assignment assignment = (Assignment) node;
			Expression rightHandSide = assignment.getRightHandSide();
			Expression copiedRightOp = (Expression) astRewrite
					.createCopyTarget(rightHandSide);
			if (assignment.getOperator() == org.eclipse.jdt.core.dom.Assignment.Operator.ASSIGN) {
				ITypeBinding rightHandSideType = rightHandSide
						.resolveTypeBinding();
				copiedRightOp = createNarrowCastIfNessecary(copiedRightOp,
						rightHandSideType, ast, variableType, is50OrHigher);
				return copiedRightOp;
			}
			if (getterExpression != null) {
				InfixExpression infix = ast.newInfixExpression();
				infix.setLeftOperand(getterExpression);
				infix.setOperator(ASTNodes.convertToInfixOperator(assignment
						.getOperator()));
				infix.setRightOperand(copiedRightOp);
				ITypeBinding infixType = infix.resolveTypeBinding();
				return createNarrowCastIfNessecary(infix, infixType, ast,
						variableType, is50OrHigher);
			}
		} else if (node.getNodeType() == 37) {
			PostfixExpression po = (PostfixExpression) node;
			if (po.getOperator() == org.eclipse.jdt.core.dom.PostfixExpression.Operator.INCREMENT)
				op = org.eclipse.jdt.core.dom.InfixExpression.Operator.PLUS;
			if (po.getOperator() == org.eclipse.jdt.core.dom.PostfixExpression.Operator.DECREMENT)
				op = org.eclipse.jdt.core.dom.InfixExpression.Operator.MINUS;
		} else if (node.getNodeType() == 38) {
			PrefixExpression pe = (PrefixExpression) node;
			if (pe.getOperator() == org.eclipse.jdt.core.dom.PrefixExpression.Operator.INCREMENT)
				op = org.eclipse.jdt.core.dom.InfixExpression.Operator.PLUS;
			if (pe.getOperator() == org.eclipse.jdt.core.dom.PrefixExpression.Operator.DECREMENT)
				op = org.eclipse.jdt.core.dom.InfixExpression.Operator.MINUS;
		}
		if (op != null && getterExpression != null)
			return createInfixInvocationFromPostPrefixExpression(op,
					getterExpression, ast, variableType, is50OrHigher);
		else
			return null;
	}
 
	private static boolean isNotInBlock(ASTNode parent) {
		ASTNode statement = parent.getParent();
		boolean isStatement = statement.getNodeType() != 21;
		ASTNode block = statement.getParent();
		boolean isBlock = block.getNodeType() == 8 || block.getNodeType() == 50;
		boolean isControlStatemenBody = ASTNodes
				.isControlStatementBody(statement.getLocationInParent());
		return isStatement || !isBlock && !isControlStatemenBody;
	}
 
	private static Expression createInfixInvocationFromPostPrefixExpression(
			org.eclipse.jdt.core.dom.InfixExpression.Operator operator,
			Expression getterExpression, AST ast, ITypeBinding variableType,
			boolean is50OrHigher) {
		InfixExpression infix = ast.newInfixExpression();
		infix.setLeftOperand(getterExpression);
		infix.setOperator(operator);
		NumberLiteral number = ast.newNumberLiteral();
		number.setToken("1");
		infix.setRightOperand(number);
		ITypeBinding infixType = infix.resolveTypeBinding();
		return createNarrowCastIfNessecary(infix, infixType, ast, variableType,
				is50OrHigher);
	}
 
	private static Expression createNarrowCastIfNessecary(
			Expression expression, ITypeBinding expressionType, AST ast,
			ITypeBinding variableType, boolean is50OrHigher) {
		PrimitiveType castTo = null;
		if (variableType.isEqualTo(expressionType))
			return expression;
		if (is50OrHigher) {
			if (ast.resolveWellKnownType("java.lang.Character").isEqualTo(
					variableType))
				castTo = ast.newPrimitiveType(PrimitiveType.CHAR);
			if (ast.resolveWellKnownType("java.lang.Byte").isEqualTo(
					variableType))
				castTo = ast.newPrimitiveType(PrimitiveType.BYTE);
			if (ast.resolveWellKnownType("java.lang.Short").isEqualTo(
					variableType))
				castTo = ast.newPrimitiveType(PrimitiveType.SHORT);
		}
		if (ast.resolveWellKnownType("char").isEqualTo(variableType))
			castTo = ast.newPrimitiveType(PrimitiveType.CHAR);
		if (ast.resolveWellKnownType("byte").isEqualTo(variableType))
			castTo = ast.newPrimitiveType(PrimitiveType.BYTE);
		if (ast.resolveWellKnownType("short").isEqualTo(variableType))
			castTo = ast.newPrimitiveType(PrimitiveType.SHORT);
		if (castTo != null) {
			CastExpression cast = ast.newCastExpression();
			if (ASTNodes.needsParentheses(expression)) {
				ParenthesizedExpression parenthesized = ast
						.newParenthesizedExpression();
				parenthesized.setExpression(expression);
				cast.setExpression(parenthesized);
			} else {
				cast.setExpression(expression);
			}
			cast.setType(castTo);
			return cast;
		} else {
			return expression;
		}
	}
 
}

相關推薦

Eclipse get/set方法自動加上欄位註釋

編碼的時候通常要用到 JavaBean ，而在我們經常把註釋寫在欄位上面，但生成的Get/Set方法不會生成，通過修改Eclipse原始碼可解決，直接上例子: /** * 員工ID */ private String

Eclipse中get/set方法自動生成

ima ctrl set 分享圖片 com ctrl+alt getters 方法 inf 代碼中點擊右鍵（快捷鍵Ctrl+Alt+S） ->Source ->Generate Getters and Setters... ->全選（或選擇需要生成的字段/

J2EE系列之Struts2學習筆記（二）---使用get/set方法自動獲取/設定引數值

上一篇部落格中講了struts2的配置以及實現了一個簡單的helloWorld程式。這一片部落格講一下如何使用get/set函式來自動獲取/設定引數值。 1.開啟eclipse，新建一個名為SecondLearnStruts2Chap02的Dynamic Web Proje

Myeclipse自動生成的get set方法 加上文字註釋

步驟： 1：在myeclipse/eclisp中搜索找到org.eclipse.jdt.ui_*.jar（*是版本號） 2：將jar用解壓rar方式開啟 3：找到\org\eclipse\jdt\internal\corext\codemanipulation這個目

c++ 利用巨集自動生成get set 方法

1.非指標型別的成員變數的生成 // PropertyBuilderByName 用於生成類的成員變數 // 並生成set和get方法 // type 為變數型別 // access_permission 為變數的訪問許可權(public, priavte, protected)

第02講 struts2的get和set方法自動獲取和自動設定資料

第二章設定資料 1，複製專案HeadFirstStruts2chapter01 改名為：HeadFirstStruts2chapter02。修改Web Project Settings 為HeadFirstStruts2chapter02，HelloWorldAction中設定成員變數name屬

eclipse 匯入maven 專案後,使用lombok的@Data, 導致get/set 方法報錯

在專案的實體類中.使用@Data 註解後,不用手動生成 set/get方法,lombok 會在編譯的時候,自動插入set/get方法, 但是在匯入maven 專案的時候,set/get 方法會報錯,找不到set/get方法 在maven 倉庫中找到lombok的jar包,雙擊jar包,會

分類不能自動建立 get set 方法

前幾天有人問我一個問題：為什麼分類不能自動建立get set方法。老實說，筆者從來沒有去思考過這個問題。於是這次通過程式碼實踐跟runtime原始碼來探究這個問題。 準備工作 為了能減少輸出類資料的程式碼工作，筆者基於NSObject的分類封裝了一套程式碼   其中輸出類例項變數的具體程式碼：

java:Eclipse使用快捷鍵，快速建立構造方法和get/set方法

`public class person { private String name; private int age; public person() {//alt+shift+s 在加c,建立父類空參建構函式 super(); } public person(String nam

eclipse中如何為生成的get/set方法添加註釋

我需要這樣的get/set方法 /** * 獲取起始頁 * * @return the startIndex */ public int getStartIndex() { return startIndex; } /** * 設定起始頁

定義get/set方法快捷方式

blog height eight 方式 src alt getter setter 點擊 定義get/set方法可以通過鼠標進行完成，這裏有一個簡單的通過編輯器默認生成getter/setter,編輯器會生成默認生成get/set方法 第一步：右鍵鼠標，如圖所示選擇 第

mybatis:延遲加載時不要在get/set方法上面添加final關鍵字(原創)

沒有 tle lan nco odin .com 延遲加載 apache 被調用 1.mybatis-config.xml：<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE configuration

對象（三）——屬性類型，get/set方法

表示 method table enume 函數 tab value num 不能 屬性類型 1. 數據類型 Configurable: true|false，表示能否通過delete將屬性刪除，默認為true。當把屬性的Configurable設置為false後，該屬性

使用java反射機制動態調用javabean的get,set方法

pre 完成 cep doc return 形參 語言 基本 實例 轉自：https://blog.csdn.net/lixinyao5281/article/details/70146177?locationNum=14&fps=1&t=149327688

Android-NDK學習記錄4-C呼叫Java靜態方法修改靜態欄位

一. jni互動相關-方法簽名 方法簽名在jni的使用中經常都會用到，在java中會有過載，那麼定位到一個方法的方式：類+方法名稱+方法簽名，那麼我們先學習下簽名規則： 基本型別簽名： 咱們基本型別有各自的簽名，如下表 型別名

JAVA基礎get/set方法理解

前言 在初學JAVA的時候，對最基礎的get()和set()方法一直很疑惑。 當我們將某些變數屬性設定為private(私有)後，就必須通過設定setXXX和getXXX方法來完成對成員變數的賦值和取值操作。 在剛開始學習java時一直很疑惑為什麼不直接將成員變數設為public(公

註解生成get/set方法,讓程式碼更簡潔 lombok

一、settings--->plugins--->輸入搜尋 Lombok Plugin 安裝後，重啟IDEA即可生效二、在pom.xml三、在類上面寫上註解四、常用的註解val : 最終區域

Java反射實體類屬性（get ,set方法）

反射授予了你的程式碼訪問裝載進JVM內的Java類的內部資訊的許可權，並且允許你編寫在程式執行期間與所選擇的類的一同工作的程式碼，而不是在原始碼中。這種機制使得反射成為建立靈活的應用程式的強大工具，但是要小心的是，如果使用不恰當，反射會帶來很大的副作用。在這篇文章中，軟體諮

select @@Identity 返回自動遞增欄位的值。

1. IDENTITY 列不能由使用者直接更新，它是由系統自動維護的。 2.該列資料型別必須為數值型：int, smallint, tinyint, decimal or numeric with scale 0。 3.該列不能為 null。 4.不能在該列上設定預設值。 5

ThinkPHP查詢資料的時候，自動把欄位名的大寫切換成小寫的問題！

前幾天心血來潮把以前寫的一個專案翻出來看看，可是沒有資料庫，只有根據程式碼提示不斷的重建資料庫。在這個過程中，發現自己在資料庫裡定義為大寫的欄位，在查詢和判斷的時候，報錯說怎麼也找不到，後來經過列印資料的時候才發現，查詢以後，ThinkPHP自動把我定義為大寫的欄位轉換為小