מדריך לארכיטיפ של מייבן
1. סקירה כללית
ארכיטיפ של Maven הוא הפשטה של סוג של פרויקט שניתן לייצר אותו לפרויקט Maven המותאם אישית. בקצרה, זו תבנית פרויקט תבנית שממנה נוצרים פרויקטים אחרים.
היתרון העיקרי בשימוש בארכיטיפים הוא סטנדרטיזציה של פיתוח הפרויקטים ומאפשרים למפתחים לעקוב אחר שיטות העבודה המומלצות תוך שהם מגדילים את פרויקטים מהירים יותר.
במדריך זה נבחן כיצד ליצור ארכיטיפ מותאם אישית ולאחר מכן כיצד להשתמש בו ליצירת פרויקט Maven דרך תוסף maven-archetype.
2. מתאר ארכיטיפ של Maven
מתאר ארכיטיפ של Maven הוא לב הפרויקט של ארכיטיפ. זהו קובץ XML בשם archetype-metadata.xml וממוקם ב META-INF / maven מדריך הצנצנת.
הוא משמש לתיאור המטא נתונים של ארכיטיפים:
בר src / main / java ** / *. java ה חובה נכסים תג משמש למתן נכסים במהלך יצירת הפרויקט. לפיכך, נתבקש לספק ערכים עבורם, עם הבחירה לקבל את ערך ברירת המחדל.
קבצי קבצים, מאידך, משמשים לקביעת התצורה של המשאבים שיועתקו לפרויקט שנוצר בטון. קובץ מסונן פירושו שמקומות המיקום יוחלפו בערכים המסופקים במהלך תהליך הייצור.
ועל ידי שימוש ארוז = "נכון" בתוך ה fileSetאנו אומרים שקבצים נבחרים יתווספו להיררכיית התיקיות שצוינה על ידי חֲבִילָה תכונה.
אם אנו רוצים ליצור פרויקט רב-מודולי, אז התג מודולים יכול לעזור בתצורה של כל המודולים של הפרויקט שנוצר.
שים לב שקובץ זה עוסק בארכיטיפ 2 ומעלה. בגרסה 1.0.x, הקובץ פשוט נקרא archetype.xml והיה לו מבנה אחר.
לקבלת מידע נוסף, בהחלט עיין במסמכי הרשמי של אפאצ'י.
3. כיצד ליצור ארכיטיפ
ארכיטיפ הוא פרויקט רגיל של Maven עם התוכן הנוסף הבא:
- src / main / resources / archetype-resources היא התבנית ממנה מועתקים המשאבים לפרויקט החדש שנוצר
- src / main / resources / META-INF / maven / archetype-metadata.xml: הוא המתאר המשמש לתיאור המטא נתונים של ארכיטיפים
כדי ליצור ארכיטיפ באופן ידני, נוכל להתחיל בפרויקט Maven שנוצר לאחרונה ואז נוכל להוסיף את המשאבים שהוזכרו לעיל.
לחלופין, אנו יכולים ליצור אותו באמצעות תוסף archetype-maven, ואז התאם אישית את תוכן ה- משאבי ארכיטיפ מדריך ו archetype-metadata.xml קוֹבֶץ.
כדי ליצור את הארכיטיפ, נוכל להשתמש ב:
ארכיטקט mvn: צור -B -DarchetypeArtifactId = maven-archetype-archetype \ -DarchetypeGroupId = maven-archetype \ -DroupId = com.baeldung \ -DartifactId = ארכיטיפ מבחןאנו יכולים גם ליצור את הארכיטיפ מפרויקט Maven קיים:
ארכיטיפ mvn: create-from-projectזה נוצר ב יעד / מקורות שנוצרו / ארכיטיפ, מוכן לשימוש.
לא משנה איך יצרנו את הארכיטיפ, נגיע למבנה הבא:
ארכיטיפ-שורש / ├── pom.xml └── src └── ראשי ├── java └── משאבים ├── משאבי ארכיטיפ │ ├── pom.xml │ └── src └── META-INF └── maven └── archetype-metadata.xmlכעת אנו יכולים להתחיל לבנות את הארכיטיפ שלנו על ידי הכנסת משאבים ל משאבי ארכיטיפ ספריה והגדרת התצורה שלהם ב- archetype-metadata.xml קוֹבֶץ.
4. בניית הארכיטיפ
עכשיו אנחנו מוכנים להתאים אישית את הארכיטיפ שלנו. לשיא של תהליך זה, אנו נציג את יצירת ארכיטיפ פשוט של Maven ליצירת יישום RESTful המבוסס על JAX-RS 2.1.
בוא נקרא לזה maven-archetype.
4.1. אריזות ארכיטיפ
נתחיל בשינוי ה- pom.xml של פרויקט הארכיטיפ שנמצא תחת ספריית maven-archetype:
maven-archetypeאריזות מסוג זה זמינות בזכות אריזה לארכיטיפ סיומת:
org.apache.maven.archetype אריזה של ארכיטיפ 3.0.1 4.2. הוספת ה- pom.xml
בואו ניצור כעת pom.xml קובץ שנמצא מתחת ל- משאבי ארכיטיפ מַדרִיך:
$ {groupId} $ {artifactId} $ {version} מלחמה javax.ws.rs javax.ws.rs-api 2.1 מסופק כמו שאנו יכולים לראות, groupId, artifactId ו גִרְסָה הם פרמטרים. הם יוחלפו במהלך יצירת פרויקט חדש מארכיטיפ זה.
אנו יכולים להכניס את כל הדרוש לפרויקט שנוצר, כמו תלות ותוספים pom.xml. כאן הוספנו את התלות ב- JAX RS מכיוון שהארכיטיפ ישמש ליצירת יישום מבוסס RESTful.
4.3. הוספת משאבים נדרשים
לאחר מכן, אנו יכולים להוסיף קצת קוד Java ליישום שלנו archetype-resources / src / main / java.
מחלקה לתצורה של יישום JAX-RS:
חבילה $ {package}; // import @ApplicationPath ("$ {app-path}") AppConfig מרחיב את היישום הציבורי {}ושיעור למשאב פינג:
@Path ("פינג") מחלקה ציבורית PingResource {// ...}לבסוף, שים את קובץ תצורת השרת, server.xml, ב archetype-resources / src / main / config / liberty.
4.4. קביעת תצורה של מטא נתונים
לאחר הוספת כל המשאבים הדרושים, כעת אנו יכולים להגדיר אילו מהם יועתקו במהלך הדור דרך ה- archetype-metadata.xml קוֹבֶץ.
אנו יכולים לומר לארכיטיפ שלנו שאנו רוצים להעתיק את כל קבצי המקור של Java:
src / main / java ** / *. java src / main / config / liberty server.xml כאן אנו רוצים את כל קבצי Java src / main / java מדריך, ואת server.xml קובץ מ src / main / config / liberty, להעתקה.
4.5. התקנת הארכיטיפ
כעת, לאחר שסיימנו להרכיב את הכל, נוכל להתקין את הארכיטיפ על ידי הפעלת פקודה זו:
להתקין mvnבשלב זה, הארכיטיפ נרשם בקובץ archetype-catalog.xml, ממוקם במאגר המקומי Maven, ולכן מוכן לשימוש.
5. שימוש בארכיטיפ המותקן
ה תוסף maven-archetype מאפשר למשתמש ליצור פרוייקט Maven באמצעות לִיצוֹר המטרה והארכיטיפ הקיים. למידע נוסף על תוסף זה, תוכלו לבקר בדף הבית.
פקודה זו משתמשת בתוסף זה כדי ליצור פרויקט Maven מהארכיטיפ שלנו:
ארכיטיפ mvn: ליצור -DarchetypeGroupId = com.baeldung.archetypes -DarchetypeArtifactId = maven-archetype -DarchetypeVersion = 1.0-SNAPSHOT -DgroupId = com.baeldung.restful -DartifactId = cool-jaxrs-sample -Dversion = 1.0-SNעלינו להעביר את ה- GAV של הארכיטיפ שלנו כטיעונים ל תוסף maven-archetype: צור מטרה. אנו יכולים גם להעביר את ה- GAV של פרויקט הבטון שאנו רוצים לייצר, אחרת נוכל לספק אותם במצב אינטראקטיבי.
הבטון מדגם cool-jaxrs לכן הפרויקט שנוצר מוכן להפעלה ללא שינויים. אז נוכל להריץ את זה פשוט על ידי הפעלת פקודה זו:
חירות חבילות mvn: לרוץלאחר מכן נוכל לגשת לכתובת אתר זו:
// localhost: 9080 / cool-jaxrs-sample // פינג6. מסקנה
במאמר זה הראינו כיצד לבנות ולהשתמש בארכיטיפ של Maven.
הדגמנו כיצד ליצור את הארכיטיפ ואז להגדיר את תצורת משאבי התבנית דרך ה- archetype-metadata.xml קוֹבֶץ.
את הקוד, כרגיל, ניתן למצוא ב- Github.
