1. Elakkan Kod Berulang
Java adalah bahasa yang bagus tetapi kadang-kadang terlalu rumit untuk perkara yang harus anda lakukan dalam kod anda untuk tugas biasa atau pematuhan dengan beberapa amalan kerangka kerja. Ini sering kali tidak memberi nilai nyata kepada bahagian perniagaan program anda - dan di sinilah Lombok berada di sini untuk menjadikan hidup anda lebih bahagia dan diri anda lebih produktif.
Cara kerjanya adalah dengan memasukkan ke dalam proses membina dan membuat auto bytecode Java ke dalam fail .class anda mengikut sebilangan anotasi projek yang anda perkenalkan dalam kod anda.
Menyertakannya dalam binaan anda, sistem mana pun yang anda gunakan, sangat lurus ke hadapan. Halaman projek mereka mempunyai arahan terperinci mengenai spesifiknya. Sebilangan besar projek saya adalah berdasarkan kepada pengguna, jadi saya biasanya meletakkan kebergantungan mereka dalam ruang lingkup yang disediakan dan saya harus pergi:
... org.projectlombok lombok 1.18.10 provided ... Periksa versi terkini yang terdapat di sini.
Perhatikan bahawa bergantung pada Lombok tidak akan membuat pengguna .jar Anda juga bergantung padanya, kerana ini adalah pergantungan binaan murni, bukan runtime.
2. Pemula / Pengatur, Pembina - Begitu Berulang
Memasukkan sifat objek melalui kaedah getter dan setter umum adalah praktik umum di dunia Java, dan banyak kerangka bergantung pada pola "Java Bean" ini secara meluas: kelas dengan konstruktor kosong dan kaedah get / set untuk "sifat".
Ini sangat biasa sehingga kebanyakan IDE menyokong kod autogenerasi untuk corak ini (dan banyak lagi). Walau bagaimanapun, kod ini perlu disimpan di sumber anda dan juga dipelihara ketika, katakanlah, harta baru ditambahkan atau bidang diganti.
Mari pertimbangkan kelas ini yang ingin kita gunakan sebagai entiti JPA sebagai contoh:
@Entity public class User implements Serializable { private @Id Long id; // will be set when persisting private String firstName; private String lastName; private int age; public User() { } public User(String firstName, String lastName, int age) { this.firstName = firstName; this.lastName = lastName; this.age = age; } // getters and setters: ~30 extra lines of code }Ini adalah kelas yang agak sederhana, tetapi masih dipertimbangkan jika kita menambahkan kod tambahan untuk getter dan setter, kita akan mempunyai definisi di mana kita akan mempunyai lebih banyak kod nilai sifar boilerplate daripada maklumat perniagaan yang berkaitan: "Pengguna mempunyai yang pertama dan nama belakang, dan umur. "
Mari kita sekarang Lombok-ize kelas ini:
@Entity @Getter @Setter @NoArgsConstructor // <--- THIS is it public class User implements Serializable { private @Id Long id; // will be set when persisting private String firstName; private String lastName; private int age; public User(String firstName, String lastName, int age) { this.firstName = firstName; this.lastName = lastName; this.age = age; } }Dengan menambah @Getter dan @Setter anotasi kami memberitahu Lombok ke, baik, menjana ini untuk semua bidang kelas. @NoArgsConstructor akan menyebabkan generasi konstruktor kosong.
Perhatikan ini adalah keseluruhan kod kelas, saya tidak menghilangkan apa-apa berbanding versi di atas dengan komen // getter dan setter . Untuk tiga kelas atribut yang berkaitan, ini adalah penjimatan kod yang ketara!
Sekiranya anda menambahkan atribut (sifat) ke kelas Pengguna anda , perkara yang sama akan berlaku: anda menggunakan anotasi pada jenis itu sendiri sehingga mereka akan mengurus semua bidang secara lalai.
Bagaimana jika anda ingin memperincikan keterlihatan beberapa sifat? Sebagai contoh, saya ingin memastikan pakej pengubah medan id entiti saya atau dilindungi kelihatan kerana diharapkan dapat dibaca tetapi tidak ditetapkan secara jelas oleh kod aplikasi. Cukup gunakan @Setter berbutir halus untuk bidang ini:
private @Id @Setter(AccessLevel.PROTECTED) Long id;3. Pemalas Malas
Selalunya, aplikasi perlu melakukan operasi yang mahal dan menyimpan hasilnya untuk penggunaan seterusnya.
Sebagai contoh, katakanlah kita perlu membaca data statik dari fail atau pangkalan data. Secara amnya adalah amalan yang baik untuk mengambil data ini sekali dan kemudian menyimpannya untuk membolehkan bacaan dalam memori dalam aplikasi. Ini menjimatkan aplikasi daripada mengulangi operasi yang mahal.
Pola biasa yang lain ialah mengambil data ini hanya apabila ia pertama kali diperlukan . Dengan kata lain, hanya dapatkan data apabila penerima yang sesuai dipanggil pertama kali. Ini dipanggil pemalas malas .
Katakan bahawa data ini disimpan dalam cache sebagai medan dalam kelas. Kelas sekarang mesti memastikan bahawa sebarang akses ke bidang ini mengembalikan data yang disimpan dalam cache. Salah satu cara yang mungkin untuk melaksanakan kelas seperti itu adalah dengan membuat kaedah mendapatkan data hanya jika bidang kosong . Atas sebab ini, kita panggil ini malas getter .
Lombok menjadikannya mungkin dengan parameter malas dalam penjelasan @ Getter yang kita lihat di atas.
Sebagai contoh, pertimbangkan kelas sederhana ini:
public class GetterLazy { @Getter(lazy = true) private final Map transactions = getTransactions(); private Map getTransactions() { final Map cache = new HashMap(); List txnRows = readTxnListFromFile(); txnRows.forEach(s -> { String[] txnIdValueTuple = s.split(DELIMETER); cache.put(txnIdValueTuple[0], Long.parseLong(txnIdValueTuple[1])); }); return cache; } }Ini membaca beberapa transaksi dari fail ke dalam Peta . Oleh kerana data dalam fail tidak berubah, kami akan menyimpannya sekali dan membenarkan akses melalui penerima.
Sekiranya sekarang kita melihat kod yang dikumpulkan dari kelas ini, kita akan melihat kaedah mendapatkan yang mengemas kini cache jika nol dan kemudian mengembalikan data yang di-cache :
public class GetterLazy { private final AtomicReference transactions = new AtomicReference(); public GetterLazy() { } //other methods public Map getTransactions() { Object value = this.transactions.get(); if (value == null) { synchronized(this.transactions) { value = this.transactions.get(); if (value == null) { Map actualValue = this.readTxnsFromFile(); value = actualValue == null ? this.transactions : actualValue; this.transactions.set(value); } } } return (Map)((Map)(value == this.transactions ? null : value)); } }Sangat menarik untuk menunjukkan bahawa Lombok membungkus bidang data dalam AtomicReference. Ini memastikan kemas kini atom ke bidang transaksi . Kaedah getTransactions () juga memastikan membaca fail jika transaksi tidak sah.
Penggunaan medan transaksi AtomicReference secara langsung dari dalam kelas tidak digalakkan. Sebaiknya gunakan kaedah getTransactions () untuk mengakses medan.
Atas sebab ini, jika kita menggunakan anotasi Lombok lain seperti ToString di kelas yang sama , ia akan menggunakan getTransactions () dan bukannya mengakses lapangan secara langsung.
4. Kelas Nilai / DTO
Terdapat banyak situasi di mana kita ingin menentukan jenis data dengan satu-satunya tujuan untuk mewakili "nilai" yang kompleks atau sebagai "Objek Pemindahan Data", selalunya dalam bentuk struktur data yang tidak berubah yang kita bina sekali dan tidak pernah mahu berubah .
Kami merancang kelas untuk mewakili operasi masuk yang berjaya. Kami mahu semua medan tidak kosong dan objek tidak dapat diubah sehingga kami dapat mengakses sifatnya dengan selamat:
public class LoginResult { private final Instant loginTs; private final String authToken; private final Duration tokenValidity; private final URL tokenRefreshUrl; // constructor taking every field and checking nulls // read-only accessor, not necessarily as get*() form }Sekali lagi, jumlah kod yang harus kita tulis untuk bahagian yang dikomentari akan mempunyai jumlah yang jauh lebih besar daripada maklumat yang ingin kita kumpulkan dan yang mempunyai nilai nyata bagi kita. Kita boleh menggunakan Lombok lagi untuk memperbaikinya:
@RequiredArgsConstructor @Accessors(fluent = true) @Getter public class LoginResult { private final @NonNull Instant loginTs; private final @NonNull String authToken; private final @NonNull Duration tokenValidity; private final @NonNull URL tokenRefreshUrl; }Cukup tambahkan anotasi @RequiredArgsConstructor dan anda akan mendapat konstruktor untuk semua bidang terakhir di kelas, sama seperti yang anda nyatakan . Menambah @NonNull ke atribut menjadikan pembina kami memeriksa kebolehtolakan dan membuang NullPointerExceptions dengan sewajarnya. Ini juga akan berlaku sekiranya padang tidak muktamad dan kami menambahkan @Setter untuk mereka.
Don't you want boring old get*() form for your properties? Because we added @Accessors(fluent=true) in this example “getters” would have the same method name as the properties: getAuthToken() simply becomes authToken().
This “fluent” form would apply to non-final fields for attribute setters and as well allow for chained calls:
// Imagine fields were no longer final now return new LoginResult() .loginTs(Instant.now()) .authToken("asdasd") . // and so on5. Core Java Boilerplate
Another situation in which we end up writing code we need to maintain is when generating toString(), equals() and hashCode() methods. IDEs try to help with templates for autogenerating these in terms of our class attributes.
We can automate this by means of other Lombok class-level annotations:
- @ToString: will generate a toString() method including all class attributes. No need to write one ourselves and maintain it as we enrich our data model.
- @EqualsAndHashCode: will generate both equals() and hashCode() methods by default considering all relevant fields, and according to very well though semantics.
These generators ship very handy configuration options. For example, if your annotated classes take part of a hierarchy you can just use the callSuper=true parameter and parent results will be considered when generating the method's code.
More on this: say we had our User JPA entity example include a reference to events associated to this user:
@OneToMany(mappedBy = "user") private List events;We wouldn't like to have the whole list of events dumped whenever we call the toString() method of our User, just because we used the @ToString annotation. No problem: just parameterize it like this: @ToString(exclude = {“events”}), and that won't happen. This is also helpful to avoid circular references if, for example, UserEvents had a reference to a User.
For the LoginResult example, we may want to define equality and hash code calculation just in terms of the token itself and not the other final attributes in our class. Then, simply write something like @EqualsAndHashCode(of = {“authToken”}).
Bonus: if you liked the features from the annotations we've reviewed so far you may want to examine @Data and @Value annotations as they behave as if a set of them had been applied to our classes. After all, these discussed usages are very commonly put together in many cases.
5.1. (Not) Using the @EqualsAndHashCode With JPA Entities
Whether to use the default equals() and hashCode() methods or create custom ones for the JPA entities, is an often discussed topic among developers. There are multiple approaches we can follow; each having its pros and cons.
By default, @EqualsAndHashCode includes all non-final properties of the entity class. We can try to “fix” this by using the onlyExplicitlyIncluded attribute of the @EqualsAndHashCode to make Lombok use only the entity's primary key. Still, however, the generated equals() method can cause some issues. Thorben Janssen explains this scenario in greater detail in one of his blog posts.
In general, we should avoid using Lombok to generate the equals() and hashCode() methods for our JPA entities!
6. The Builder Pattern
The following could make for a sample configuration class for a REST API client:
public class ApiClientConfiguration { private String host; private int port; private boolean useHttps; private long connectTimeout; private long readTimeout; private String username; private String password; // Whatever other options you may thing. // Empty constructor? All combinations? // getters... and setters? }We could have an initial approach based on using the class default empty constructor and providing setter methods for every field. However, we'd ideally want configurations not to be re-set once they've been built (instantiated), effectively making them immutable. We therefore want to avoid setters, but writing such a potentially long args constructor is an anti-pattern.
Instead, we can tell the tool to generate a builder pattern, preventing us to write an extra Builder class and associated fluent setter-like methods by simply adding the @Builder annotation to our ApiClientConfiguration.
@Builder public class ApiClientConfiguration { // ... everything else remains the same }Leaving the class definition above as such (no declare constructors nor setters + @Builder) we can end up using it as:
ApiClientConfiguration config = ApiClientConfiguration.builder() .host("api.server.com") .port(443) .useHttps(true) .connectTimeout(15_000L) .readTimeout(5_000L) .username("myusername") .password("secret") .build();7. Checked Exceptions Burden
Lots of Java APIs are designed so that they can throw a number of checked exceptions client code is forced to either catch or declare to throws. How many times have you turned these exceptions you know won't happen into something like this?
public String resourceAsString() { try (InputStream is = this.getClass().getResourceAsStream("sure_in_my_jar.txt")) { BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8")); return br.lines().collect(Collectors.joining("\n")); } catch (IOException | UnsupportedCharsetException ex) { // If this ever happens, then its a bug. throw new RuntimeException(ex); <--- encapsulate into a Runtime ex. } }If you want to avoid this code patterns because the compiler won't be otherwise happy (and, after all, you know the checked errors cannot happen), use the aptly named @SneakyThrows:
@SneakyThrows public String resourceAsString() { try (InputStream is = this.getClass().getResourceAsStream("sure_in_my_jar.txt")) { BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8")); return br.lines().collect(Collectors.joining("\n")); } }8. Ensure Your Resources Are Released
Java 7 introduced the try-with-resources block to ensure your resources held by instances of anything implementing java.lang.AutoCloseable are released when exiting.
Lombok provides an alternative way of achieving this, and more flexibly via @Cleanup. Use it for any local variable whose resources you want to make sure are released. No need for them to implement any particular interface, you'll just get its close() method called.
@Cleanup InputStream is = this.getClass().getResourceAsStream("res.txt");Your releasing method has a different name? No problem, just customize the annotation:
@Cleanup("dispose") JFrame mainFrame = new JFrame("Main Window");9. Annotate Your Class to Get a Logger
Many of us add logging statements to our code sparingly by creating an instance of a Logger from our framework of choice. Say, SLF4J:
public class ApiClientConfiguration { private static Logger LOG = LoggerFactory.getLogger(ApiClientConfiguration.class); // LOG.debug(), LOG.info(), ... }This is such a common pattern that Lombok developers have cared to simplify it for us:
@Slf4j // or: @Log @CommonsLog @Log4j @Log4j2 @XSlf4j public class ApiClientConfiguration { // log.debug(), log.info(), ... }Many logging frameworks are supported and of course you can customize the instance name, topic, etc.
10. Write Thread-Safer Methods
In Java you can use the synchronized keyword to implement critical sections. However, this is not a 100% safe approach: other client code can eventually also synchronize on your instance, potentially leading to unexpected deadlocks.
This is where @Synchronized comes in: annotate your methods (both instance and static) with it and you'll get an autogenerated private, unexposed field your implementation will use for locking:
@Synchronized public /* better than: synchronized */ void putValueInCache(String key, Object value) { // whatever here will be thread-safe code }11. Automate Objects Composition
Java does not have language level constructs to smooth out a “favor composition inheritance” approach. Other languages have built-in concepts such as Traits or Mixins to achieve this.
Lombok's @Delegate comes in very handy when you want to use this programming pattern. Let's consider an example:
- We want Users and Customers to share some common attributes for naming and phone number
- We define both an interface and an adapter class for these fields
- We'll have our models implement the interface and @Delegate to their adapter, effectively composing them with our contact information
First, let's define an interface:
public interface HasContactInformation { String getFirstName(); void setFirstName(String firstName); String getFullName(); String getLastName(); void setLastName(String lastName); String getPhoneNr(); void setPhoneNr(String phoneNr); }And now an adapter as a support class:
@Data public class ContactInformationSupport implements HasContactInformation { private String firstName; private String lastName; private String phoneNr; @Override public String getFullName() { return getFirstName() + " " + getLastName(); } }The interesting part comes now, see how easy it is to now compose contact information into both model classes:
public class User implements HasContactInformation { // Whichever other User-specific attributes @Delegate(types = {HasContactInformation.class}) private final ContactInformationSupport contactInformation = new ContactInformationSupport(); // User itself will implement all contact information by delegation }The case for Customer would be so similar we'd omit the sample for brevity.
12. Rolling Lombok Back?
Short answer: Not at all really.
You may be worried there is a chance that you use Lombok in one of your projects, but later want to rollback that decision. You'd then have a maybe large number of classes annotated for it… what could you do?
I have never really regretted this, but who knows for you, your team or your organization. For these cases you're covered thanks to the delombok tool from the same project.
By delombok-ing your code you'd get autogenerated Java source code with exactly the same features from the bytecode Lombok built. So then you may simply replace your original annotated code with these new delomboked files and no longer depend on it.
This is something you can integrate in your build and I have done this in the past to just study the generated code or to integrate Lombok with some other Java source code based tool.
13. Conclusion
There are some other features we have not presented in this article, I'd encourage you to take a deeper dive into the feature overview for more details and use cases.
Sebilangan besar fungsi yang kami tunjukkan mempunyai sejumlah pilihan penyesuaian yang mungkin berguna untuk mendapatkan alat menghasilkan perkara yang paling sesuai dengan amalan pasukan anda untuk menamakan dll. Sistem konfigurasi bawaan yang tersedia juga dapat membantu anda dengan itu.
Saya harap anda telah menemukan motivasi untuk memberi Lombok peluang untuk memasuki perangkat pengembangan Java anda. Cubalah dan tingkatkan produktiviti anda!
Contoh kod boleh didapati dalam projek GitHub.