pojobuilder下載 - pojobuilder原始碼下載

PojoBuilder - Pojo Builder 的程式碼產生器

作者：麥可‧卡尼姆

專案首頁：http://github.com/mkarneim/pojobuilder

關於

PojoBuilder Generator 是一個符合 Java 6 的註解處理器，可為 POJO（普通舊 Java 物件）產生流暢的建構器類別。

生成的建構器提供

一個流暢的接口，用於以類似 DSL 的方式指定 pojo 屬性的值
以及一個「build()」方法，用於使用這些值建立新的 pojo 實例。

以下是如何使用程式碼產生的 pojo 建構器的範例：

	Contact james = new ContactBuilder ()
		. withSurname ( "Bond" )
		. withFirstname ( "James" )
		. withEmail ( "[email protected]" )
		. build ();

建構器非常有用，例如，建立測試數據，您只想設定相關的數據屬性。

欲了解更多信息

測試資料建構器請參閱 http://c2.com/cgi/wiki?TestDataBuilder 和 http://www.natpryce.com/articles/000714.html。
建構器模式請參考http://en.wikipedia.org/wiki/Builder_pattern。
流暢的介面請參閱http://www.martinfowler.com/bliki/FluentInterface.html

許可證和依賴項

位於「src」目錄中的原始碼位於公共域中。有關更多信息，請閱讀複製文件。

PojoBuilder 是一個純程式碼產生器。它不會向您的專案添加任何運行時依賴項。

但是，PojoBuilder 將以下編譯時依賴項新增至您的專案中，該專案有自己的授權：

JavaWriter 2.5.0（請參閱許可證）

下載

PojoBuilder 是開源的。原始碼可在 http://github.com/mkarneim/pojobuilder 取得。對於舊版本和變更日誌，請參閱發布歷史記錄頁面。

PojoBuilder二進位檔案可從 Sonatype OSS Maven 儲存庫和 Maven Central 下載。

如果您不使用任何支援 Maven 儲存庫的建置自動化工具，您可能需要下載pojobuilder-4.3.0-jar-with-dependencies.jar以取得包含所有依賴函式庫的完整 PojoBuilder。

如何使用

PojoBuilder 產生器使用註解處理器為您產生 pojo 建構器。您可以使用以下選項來觸發程式碼產生：

透過註釋 pojo 的建構函數
透過註釋 pojo 類
透過註解工廠方法

註解構造函數

若要為 pojo 產生建構器類，您可以使用@GeneratePojoBuilder註解其建構函式之一。

讓我們來看看下面的 pojo 範例：

 public class Contact {
  private final String surname ;
  private final String firstname ;
  private String email ;

  @ GeneratePojoBuilder
  public Contact ( String surname , String firstname ) {
    this . surname = surname ;
    this . firstname = firstname ;
  }

  public String getEmail () {
    return email ;
  }

  public void setEmail ( String email ) {
    this . email = email ;
  }

  public String getSurname () {
    return surname ;
  }

  public String getFirstname () {
    return firstname ;
  }
}

@GeneratePojoBuilder 註解告訴註解處理器建立一個名為ContactBuilder的新 Java 原始檔。查看ContactBuilder.java以查看產生的原始程式碼。

請注意，建構函式必須是公共的，或者以其他方式可供產生的建構器訪問，例如，如果它受保護，則產生的建構器必須駐留在同一包中。

另請注意，建構函數參數名稱必須與 pojo 的屬性名稱完全匹配。

可選的 @ConstructorProperties 註解可用於指定從建構函式參數名稱到 pojo 上對應 bean 屬性名稱的對應（如果它們不同）。

 public class Contact {
  private final String surname ;
  private final String firstname ;
  private String email ;

  @ GeneratePojoBuilder
  @ ConstructorProperties ({ "surname" , "firstname" })
  public Contact ( String arg1 , String arg2 ) {
    this . surname = arg1 ;
    this . firstname = arg2 ;
  }

  public String getEmail () {
    return email ;
  }

  public void setEmail ( String email ) {
    this . email = email ;
  }

  public String getSurname () {
    return surname ;
  }

  public String getFirstname () {
    return firstname ;
  }
}

註釋 Pojo

如果您的 pojo 沒有建構子（或公共預設建構子），您可以使用@GeneratePojoBuilder註解其類別。

讓我們來看看下面的 pojo 範例：

 @ GeneratePojoBuilder
public class User {
  private String name ;
  private char [] password ;

  public String getName () {
    return name ;
  }

  public void setName ( String name ) {
    this . name = name ;
  }

  public char [] getPassword () {
    return password ;
  }

  public void setPassword ( char [] password ) {
    this . password = password ;
  }
}

查看UserBuilder.java以查看產生的原始碼。

註解工廠方法

或者，如果您無法存取 pojo 的原始程式碼，或者如果您不喜歡註釋 pojo，則可以註釋工廠方法：

 public class UrlFactory {

  @ GeneratePojoBuilder ( withName = "UrlBuilder" , intoPackage = "samples" )
  public static URL createUrl (
    String protocol , String host , int port , String file , URLStreamHandler handler )
      throws MalformedURLException {
    return new URL ( protocol , host , port , file , handler );
  }
}

查看UrlBuilder.java以查看產生的原始碼。

請注意，工廠方法必須是public和static 的。方法參數名稱必須與 pojo 屬性的名稱完全相符。

可選的 @FactoryProperties 註解可用於指定從工廠方法參數名稱到 pojo 上對應 bean 屬性名稱的對應（如果它們不同）。

 public class FileFactory {

  @ GeneratePojoBuilder ( intoPackage = "samples" )
  @ FactoryProperties ({ "path" })
  public static File createFile ( String arg1 ) {
    return new File ( arg1 );
  }
}

查看FileBuilder.java以查看產生的原始程式碼。

註釋記錄

從 PojoBuilder 4.3 開始，您可以註解 Java 17 記錄類型：

 @ GeneratePojoBuilder
public record MyRecord ( int x , int y , String blah ) {}

指令

@GeneratePojoBuilder 的以下元素可用於設定程式碼產生過程的輸出。

withName=指定建構器名稱的模式。星號將替換為 pojos 簡單名稱。例如，如果 pojo 的名稱是Contact則模式Fluent*Builder的結果將變成FluentContactBuilder 。預設模式是*Builder 。
withConstructor=指定建構器建構函式的可見性。預設為Visibility.PUBLIC 。
intoPackage=指定產生的建構器的套件。星號將替換為 pojos 包。例如，如果 pojo 的套件是com.example ，則模式*.util的結果將變為com.example.util 。預設模式是* 。
withBaseclass=指定產生的建構器的基底類別。預設類別是Object.class 。
withBuilderInterface=指定產生的建構器的介面。該介面必須聲明一個類型參數和一個將此類型作為傳回類型的建置方法。有關範例，請參閱Address.java 、 Builder.java和AddressBuilder.java 。預設值為Void.class ，這表示不應實作任何介面。
withBuilderProperties=指定產生的建構器是否應使用建構器介面定義基於建構器的 with 方法（請參閱上文）。有關範例，請參閱Recipient.java 、 Builder.java和RecipientBuilder.java 。預設為false 。
includeProperties=指定 pojo 的哪些屬性將包含到產生的建構器中。將包含與指定數組中的任何屬性模式相符的所有屬性。所有其他非強制性屬性將被排除。強制屬性是作為建構函式或工廠方法參數傳遞的屬性。他們永遠不會被排除在外，無論是明確的還是隱含的。有關範例，請參閱InputSourceFactory.java和InputSourceBuilder.java 。預設為* 。
exceptProperties=指定將從產生的建構器排除 pojo 的哪些屬性。與指定數組中的任何屬性模式相符的所有屬性都將被排除，強制屬性除外。強制屬性是作為建構函式或工廠方法參數傳遞的屬性。他們永遠不會被排除在外，無論是明確的還是隱含的。有關範例，請參閱CalendarFactory.java和GregorianCalendarBuilder.java 。預設為空數組。
withGenerationGap=指定是否使用代溝模式。如果啟用，這將產生兩個類別（而不是一個），其中一個包含普通的建構器程式碼，而另一個類別擴展第一個類，並且是手寫程式碼的空模板。請將其移出 generated-sources 資料夾以防止其被覆蓋。有關範例，請參閱Player.java 、 PlayerBuilder.java和AbstractPlayerBuilder.java 。預設為false 。
withCopyMethod=指定是否應產生複製方法。使用 copy 方法從給定的 pojo 實例初始化建構器的值。有關範例，請參閱TextEmail.java和TextEmailBuilder.java 。預設為false 。
withOptionalProperties=指定產生的建構器是否應使用指定的「可選」類型定義基於可選的 setter 方法。範例是 Java 8 中引入的 Google Guava 的com.google.common.base.Optional和Void.class java.util.Optional
withSetterNamePattern=指定產生的 setter 方法的名稱模式。星號將替換為該屬性的原始名稱。預設with* 。
withValidator=指定用於驗證建立的 pojo 的驗證器類別。該類別必須定義一個validate方法，該方法具有與 pojo 類型相容的參數。如果驗證失敗，則該方法必須拋出一些運行時異常（或其子類別之一）。有關範例，請參閱Credentials.java 、 CredentialsValidator.java和CredentialsBuilder.java 。
withFactoryMethod=指定新增至建立建構器實例的建構器類別的靜態工廠方法的名稱。星號將替換為 pojos 簡單名稱。有關範例，請參閱Task.java和TaskBuilder.java 。預設為""表示不產生此方法。

預設配置和元註釋

從版本 3 開始，PojoBuilder 支援元註解。也就是說，您可以將 @GeneratePojoBuilder 放置到另一個註釋上，它將被繼承。

優點是：

常見的 PojoBuilder 指令可以在一處共享
該註釋還可以保存支援元註釋的其他庫的指令，將它們全部綁定到一個有意義的註釋中以在您的應用程式中使用。

以下範例定義了@AppPojo它可以在類別層級套用並封裝來自三個不同來源（PojoBuilder、Lombok 和 JSR-305）的註解。

 @ GeneratePojoBuilder ( withName = "Fluent*Builder" )
@ lombok . experimental . Value // class-level annotation from Lombok
@ javax . annotation . concurrent . Immutable // class-level annotation from JSR-305
@ Target ({ ElementType . TYPE , ElementType . ANNOTATION_TYPE })
public @interface AppPojo {
}

這可以放置到您的每個 pojo 上：

 @ AppPojo
public class Contact {
  public String name ;
}

PojoBuilder 將根據從@AppPojo註解繼承的指令產生FluentContactBuilder 。

從元註釋繼承的預設值可以被更多「本地」 @GeneratePojoBuilder註釋覆蓋：

 @ AppPojo
@ GeneratePojoBuilder ( intoPackage = "builder" )
public class Contact {
  public String name ;
}

這將像以前一樣產生FluentContactBuilder ，但生成到套件builder 。

範例

PojoBuilder wiki 提供了一本有關使用 PojoBuilder Generator 的手冊，例如用於建立用於自動化測試的特定於網域的語言。

有關一些完整的程式碼範例，請查看 src/testdata/java/samples 資料夾。

執行

要執行 PojoBuilder 註解處理器，您只需將其放入編譯時類路徑中。在執行時不需要任何函式庫，因為 PojoBuilder 註解的保留策略是CLASS 。

以下是有關如何運行 PojoBuilder 的簡要說明列表

javac 工具
梅文
搖籃
Ant的javac任務
蝕。

使用Javac

如果類別路徑中包含pojobuilder-*.jar javac編譯器將自動偵測 PojoBuilder 的存在。

例如：

 javac -cp pojobuilder-4.3.0-jar-with-dependencies.jar Contact.java

如果Contact用@GeneratePojoBuilder註釋，將產生一個ContactBuilder 。

有關詳細信息，請參閱 javac 文件。

使用Maven

將以下內容新增至專案的pom.xml中以配置 PojoBuilder 註解處理器。

 
	net.karneim
	pojobuilder
	4.3.0
	
	provided

筆記：

編譯階段會自動偵測並啟動PojoBuilder。
產生的來源會出現在標準位置： ${project.build.directory}/generated-sources/annotations 。
如果需要將產生的來源保留在target目錄以外的特定目錄中，請設定maven-compiler-plugin的generatedSourcesDirectory 。有關範例，請參閱範例 Maven pom。
如果您依賴增量編譯，那麼您可能需要使用 Maven 處理器插件。
Eclipse 用戶可能想要安裝 m2e-apt 來整合對 APT 產生的來源的支援。

使用 Gradle

這是一個小型建置腳本，展示如何使用 Gradle 執行 PojoBuilder 註解處理器。

apply plugin : ' java '

repositories {
  mavenCentral()
}

dependencies {
  compile ' net.karneim:pojobuilder:4.3.0 '
}

請注意，這不僅將 PojoBuilder 及其相依性新增至編譯時類別路徑，而且還新增至執行時類別路徑。

或者，您可以使用以下腳本將 PojoBuilder 僅新增至編譯時類路徑：

apply plugin : ' java '

repositories {
  mavenCentral()
}

configurations {
  codeGeneration
}

dependencies {
  codeGeneration ' net.karneim:pojobuilder:4.3.0 '
  compileOnly ' net.karneim:pojobuilder:4.3.0:annotations '
}
compileJava . classpath + = configurations . codeGeneration
compileTestJava . classpath + = configurations . codeGeneration

在這兩種情況下，產生的來源都會被放入標準的build/classes目錄中。

如果你想把它們放在其他地方，只需指定目的地，如下所示：

compileJava . options . compilerArgs + = [ ' -s ' , ' src/generated/java ' ]

該 wiki 包含一個擴充的 Gradle 腳本，可以完全區分程式碼產生和編譯任務。

還有另一個 Gradle 腳本可以為 Eclipse IDE 啟用 PojoBuilder。

搖籃5.0

使用 Gradle 5.0，類別路徑中的任何註解處理器都不再執行。為了讓pojobuilder再次運作，用annotationProcessor取代使用的依賴範圍

dependencies {
  annotationProcessor ' net.karneim:pojobuilder:4.3.0 '
}

使用螞蟻

以下是一些範例 ANT 建置腳本的程式碼片段，該腳本在javac任務中執行 PojoBuilder 註解處理器。

        
    ">    
    < fileset id = " libs.fileset " dir = " ${basedir}/lib " >
        < include name = " *.jar " />
    fileset >

    < path id = " class.path " >
        < fileset refid = " libs.fileset " />
    path >

    < target name = " compile " depends = " init "
            description = " Compile java sources and run annotation processor " >
    	< mkdir dir = " ${src.gen.java.dir} " />
    	< mkdir dir = " ${build.classes.dir} " />
    	< javac classpathref = " class.path " destdir = " ${build.classes.dir} " >
    		< src path = " ${src.main.java.dir} " />
    		
    		< compilerarg line = " -s ${src.gen.java.dir} " />
    	javac >
    target >