MapStruct Documentation 中文版
安裝
目錄
安裝
分發包
Apache Maven
Gradle
Apache Ant
參考指南
注:當前版本1.3.1.Final(2019年9月29日)
分發包
您可以從GitHub獲取包含MapStruct的二進制文件,源代碼和API文檔的分發包。
Apache Maven
如果使用Maven構建項目,則將以下內容添加到?pom.xml?中以使用MapStruct:
... <properties><org.mapstruct.version>1.3.1.Final</org.mapstruct.version> </properties> ... <dependencies><dependency><groupId>org.mapstruct</groupId><artifactId>mapstruct</artifactId><version>${org.mapstruct.version}</version></dependency> </dependencies> ... <build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.5.1</version> <!-- or newer version --><configuration><source>1.8</source> <!-- depending on your project --><target>1.8</target> <!-- depending on your project --><annotationProcessorPaths><path><groupId>org.mapstruct</groupId><artifactId>mapstruct-processor</artifactId><version>${org.mapstruct.version}</version></path><!-- other annotation processors --></annotationProcessorPaths></configuration></plugin></plugins> </build>Gradle
使用Gradle,您可以將以下內容添加到build.gradle中:
plugins {...id 'net.ltgt.apt' version '0.8' } dependencies {...compile 'org.mapstruct:mapstruct:1.3.1.Final'apt 'org.mapstruct:mapstruct-processor:1.3.1.Final' }您可以在GitHub上的mapstruct-examples項目中找到完整的示例。
Apache Ant
將javac如下配置的任務添加到build.xml文件中,以便在基于Ant的項目中啟用MapStruct。根據項目布局的需要調整路徑。
... <javacsrcdir = “ src / main / java”destdir = “目標/類別”classpath = “路徑/至/mapstruct-1.3.1.Final.jar” ><compilerarg line = “ -processorpath path / to / mapstruct-processor-1.3.1.Final.jar” /> <compilerarg line = “ -s目標/生成源” /> </ javac> ...您可以在GitHub上的mapstruct-examples項目中找到完整的示例。
參考指南
- 參考指南:HTML?|?PDF格式
- API文檔:JavaDoc
- 遷移說明
編輯器支持
MapStruct的一大優點是對映射配置問題的早期反饋。要在您的IDE中充分利用此功能,請確保注釋處理器隨每次編譯一起運行。
Eclipse
Maven整合
如果您正在使用Maven項目,請確保已安裝最新版本的m2e-apt插件,該插件會自動獲取并應用注釋處理器設置。
為了獲得最佳效果,請將以下內容添加到中pom.xml:
<properties><!-- automatically run annotation processors within the incremental compilation --><m2e.apt.activation>jdt_apt</m2e.apt.activation> </properties>編輯支持
對于Eclipse,我們還在開發一個插件,該插件添加了代碼完成功能(例如,用于屬性名稱)和針對常見用例的快速修復:
屬性和枚舉常量的提示
快速修復以忽略未映射的屬性
安裝
將以下圖標拖動到正在運行的Eclipse工作區中:?。
或者,您可以從Eclipse Marketplace獲得MapStruct Eclipse插件。有關更多信息和安裝最新的Snapshot版本,請訪問GitHub插件項目。
IntelliJ IDEA
根據您在Maven或Gradle項目中配??置注釋處理器的方式,IntelliJ可能會或可能不會自動選擇它。您可能需要在項目配置中親自進行確認。
Maven整合
例如,如果您使用annotationProcessorPaths在maven-compiler-plugin中使用的文檔中建議的Maven配置方式,則需要手動配置IntelliJ,直到實現功能請求IDEA-150621。另一種方法是添加mapstruct-processor與項目依賴<optional>true</optional>于你pom.xml,這應該然后自動重新拾起。
編輯支持
有一個支持MapStruct的IntelliJ插件,您可以在Jetbrains插件存儲庫中找到。該插件是開源的,你可以報告bug和功能要求這里在GitHub上。
屬性和枚舉常量的完成
從注釋轉到聲明
查找用法
NetBeans
Maven整合
如果您使用的是Maven項目,則無需執行其他操作。NetBeans使用Maven編譯您的源代碼,其中包括注釋處理器的調用。
編輯支持
我們尚不知道對NetBeans中的MapStruct映射器有特殊編輯支持的計劃。但是我們很樂意看到一個!
總結
以上是生活随笔為你收集整理的MapStruct Documentation 中文版的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: JavaStruct
- 下一篇: MapStruct超级简单的学习笔记