Java @ ביאור מיושן

1. סקירה כללית

במדריך מהיר זה, נבחן את ממשקי ה- API שהוצאו משימוש ב- Java וכיצד להשתמש ב- @ מיושן ביאור.

2. ה @ מיושן ביאור

עם התפתחות פרויקט, ה- API שלו משתנה. עם הזמן ישנם קונסטרוקציות, שדות, סוגים או שיטות מסוימים שאיננו רוצים שאנשים ישתמשו בהם יותר.

במקום לשבור את התאימות לאחור של ממשק ה- API של הפרויקט, אנו יכולים לתייג את האלמנטים הללו עם ה- @ מיושן ביאור.

@ מיושן אומר למפתחים אחרים כיה אלמנט מסומן כבר לא אמור להיות לשמש. נהוג להוסיף גם ג'אוודוק לצד ה- @ מיושן ביאור כדי להסביר מה תהיה חלופה טובה יותר שתשרת את ההתנהגות הנכונה:

עובד בכיתה ציבורית {/ ** * חישוב תקופה בין גרסאות * @ מיושן * שיטה זו אינה מקובלת יותר לחישוב זמן בין גרסאות. * 

השתמש במקום זאת ב- {@link Utils # calcPeriod (Machine)}. * * מופע מכונה @param * @ החזר זמן מחושב * / @ אינטל ציבורי מחושב (מכונת מכונה) {return machine.exportVersions (). size () * 10; }}

זכור כי מהדר מציג את אזהרת ה- API שהוצא משימוש רק אם משתמשים באלמנט Java המאושר במקום כלשהו בקוד. לכן, במקרה זה, זה יופיע רק אם היה קוד שנקרא לחשב שיטה.

גַם, אנו יכולים להעביר את הסטטוס שהוצא משימוש גם בתיעוד באמצעות ה- Javadoc @ מיושן תָג.

3. תכונות אופציונליות שנוספו ב- Java 9

Java 9 מוסיף כמה תכונות אופציונליות ל- @ מיושן ביאור: מאז ו להסרה.

ה מאז התכונה דורשת מחרוזת המאפשרת לנו להגדיר באיזו גרסה האלמנט הוצא משימוש. ערך ברירת המחדל הוא מחרוזת ריקה.

וגם להסרה הוא בוליאני המאפשר לנו לציין אם האלמנט יוסר במהדורה הבאה. ערך ברירת המחדל שלו הוא שֶׁקֶר:

עובד בכיתה ציבורית {/ ** * חישוב תקופה בין גרסאות * @ מיושן * שיטה זו אינה מקובלת יותר לחישוב זמן בין גרסאות. * 

השתמש במקום זאת ב- {@link Utils # calcPeriod (Machine)}. * * מופע מכונת @param * @ החזר זמן מחושב * / @ מיושן (מאז = "4.5", עבור הסרה = נכון) חישוב ציבורי ציבורי (מכונת מכונה) {return machine.exportVersions (). size () * 10; }}

במילים פשוטות, השימוש לעיל פירוש הדבר לחשב הוצא משימוש מאז 4.5 מהספרייה שלנו וכי היא מתוכננת להסרתה במהדורה הגדולה הבאה.

מועיל לנו להוסיף זאת מאז המהדר ייתן לנו אזהרה חזקה יותר אם הוא מגלה שאנחנו משתמשים בשיטה עם ערך זה.

ויש כבר תמיכה מ- IDEלאתר שימושים בשיטה המסומנת באמצעות forRemoval = נכון. IntelliJ, למשל, מכה באמצעות הקוד עם קו אדום במקום שחור.

4. מסקנה

במאמר מהיר זה ראינו כיצד להשתמש ב- @ מיושן ביאור והתכונות האופציונליות שלו לסימון קוד שכבר אין להשתמש בו.

קוד המקור המלא של הדוגמאות ניתן למצוא באתר GitHub.