Pengantar Proyek Lombok

1. Hindari Kode Berulang

Java adalah bahasa yang bagus tetapi terkadang terlalu bertele-tele untuk hal-hal yang harus Anda lakukan dalam kode Anda untuk tugas-tugas umum atau kepatuhan dengan beberapa praktik kerangka kerja. Hal ini sering kali tidak memberikan nilai nyata pada sisi bisnis program Anda - dan di sinilah Lombok hadir untuk membuat hidup Anda lebih bahagia dan diri Anda lebih produktif.

Cara kerjanya adalah dengan memasukkan ke dalam proses build Anda dan membuat bytecode Java secara otomatis ke dalam file .class Anda sesuai dengan sejumlah anotasi project yang Anda perkenalkan dalam kode Anda.

Memasukkannya ke dalam build Anda, sistem apa pun yang Anda gunakan, sangatlah mudah. Halaman proyek mereka memiliki instruksi rinci tentang spesifik. Sebagian besar proyek saya berbasis maven, jadi saya biasanya melepaskan ketergantungannya dalam cakupan yang disediakan dan saya siap melakukannya:

 ...  org.projectlombok lombok 1.18.10 provided  ... 

Periksa versi terbaru yang tersedia di sini.

Perhatikan bahwa bergantung pada Lombok tidak akan membuat pengguna .jar Anda bergantung padanya juga, karena ini adalah dependensi build murni, bukan runtime.

2. Getters / Setter, Constructors - Begitu Berulang

Mengenkapsulasi properti objek melalui metode pengambil dan penyetel publik adalah praktik yang umum di dunia Java, dan banyak kerangka kerja mengandalkan pola "Java Bean" ini secara ekstensif: kelas dengan konstruktor kosong dan metode get / set untuk "properti".

Ini sangat umum sehingga sebagian besar IDE mendukung pembuatan kode otomatis untuk pola ini (dan lainnya). Namun kode ini harus ada di sumber Anda dan juga dipertahankan saat, katakanlah, properti baru ditambahkan atau bidang diganti namanya.

Mari pertimbangkan kelas ini yang ingin kita gunakan sebagai entitas 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 mempertimbangkan jika kita menambahkan kode ekstra untuk getter dan setter, kita akan berakhir dengan definisi di mana kita akan memiliki lebih banyak kode nilai nol boilerplate daripada informasi bisnis yang relevan: “Pengguna memiliki yang pertama dan nama belakang, dan usia. "

Mari kita ubah kelas ini menjadi Lombok :

@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 menambahkan @Getter dan @Setter penjelasan kami diberitahu Lombok, baik, menghasilkan ini untuk semua bidang kelas. @NoArgsConstructor akan mengarah ke pembuatan konstruktor kosong.

Perhatikan bahwa ini adalah seluruh kode kelas, saya tidak menghilangkan apa pun yang bertentangan dengan versi di atas dengan // komentar getter dan setter . Untuk tiga kelas atribut yang relevan, ini adalah penghematan kode yang signifikan!

Jika Anda menambahkan lebih lanjut atribut (properti) ke kelas Pengguna Anda , hal yang sama akan terjadi: Anda menerapkan anotasi ke jenis itu sendiri sehingga mereka akan mengurus semua bidang secara default.

Bagaimana jika Anda ingin menyempurnakan visibilitas beberapa properti? Misalnya, saya ingin menyimpan paket pengubah kolom id entitas saya atau dilindungi agar terlihat karena diharapkan dapat dibaca tetapi tidak secara eksplisit diatur oleh kode aplikasi. Cukup gunakan @Setter yang lebih halus untuk bidang khusus ini:

private @Id @Setter(AccessLevel.PROTECTED) Long id;

3. Malas Getter

Seringkali, aplikasi perlu melakukan operasi yang mahal dan menyimpan hasilnya untuk penggunaan selanjutnya.

Misalnya, kita perlu membaca data statis dari file atau database. Biasanya merupakan praktik yang baik untuk mengambil data ini satu kali dan kemudian menyimpannya dalam cache untuk memungkinkan pembacaan dalam memori dalam aplikasi. Ini menyelamatkan aplikasi dari pengulangan operasi yang mahal.

Pola umum lainnya adalah mengambil data ini hanya saat dibutuhkan pertama kali . Dengan kata lain, hanya dapatkan data saat pengambil yang sesuai dipanggil pertama kali. Ini disebut pemuatan lambat .

Misalkan data ini di-cache sebagai bidang di dalam kelas. Kelas sekarang harus memastikan bahwa setiap akses ke bidang ini mengembalikan data yang di-cache. Salah satu cara yang mungkin untuk mengimplementasikan kelas seperti itu adalah dengan membuat metode pengambil mengambil data hanya jika bidangnya nol . Untuk alasan ini, kami menyebutnya malas getter .

Lombok memungkinkan hal ini dengan parameter lazy dalam anotasi @ Getter yang kita lihat di atas.

Misalnya, 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 file ke dalam Peta . Karena data dalam file tidak berubah, kami akan menyimpannya dalam cache sekali dan mengizinkan akses melalui getter.

Jika sekarang kita melihat kode yang dikompilasi dari kelas ini, kita akan melihat metode pengambil yang memperbarui cache jika nilainya null 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 bahwa Lombok membungkus bidang data dalam AtomicReference. Ini memastikan pembaruan atomik ke bidang transaksi . The getTransactions () metode juga memastikan untuk membaca file jika transaksi adalah nol.

Penggunaan bidang transaksi AtomicReference langsung dari dalam kelas tidak disarankan. Direkomendasikan untuk menggunakan metode getTransactions () untuk mengakses bidang.

Untuk alasan ini, jika kita menggunakan anotasi Lombok lain seperti ToString di kelas yang sama , ini akan menggunakan getTransactions () daripada langsung mengakses lapangan.

4. Kelas Nilai / DTO

Ada banyak situasi di mana kami ingin mendefinisikan tipe data dengan tujuan tunggal untuk merepresentasikan "nilai" yang kompleks atau sebagai "Objek Transfer Data", sebagian besar waktu dalam bentuk struktur data yang tidak dapat diubah yang kami buat sekali dan tidak pernah ingin diubah .

Kami merancang kelas untuk mewakili operasi login yang sukses. Kami ingin semua bidang menjadi non-null dan objek tidak dapat diubah sehingga kami dapat mengakses propertinya dengan aman:

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 kode yang harus kita tulis untuk bagian yang dikomentari akan memiliki volume yang jauh lebih besar daripada informasi yang ingin kita rangkum dan yang memiliki nilai nyata bagi kita. Kita bisa menggunakan Lombok lagi untuk meningkatkan ini:

@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 mendapatkan konstruktor untuk semua bidang akhir di kelas, sama seperti Anda mendeklarasikannya. Menambahkan @NonNull ke atribut membuat konstruktor memeriksa nullability dan memunculkan NullPointerExceptions yang sesuai. Ini juga akan terjadi jika kolom non-final dan kami menambahkan @Setter untuk kolom tersebut .

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 on

5. 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.

Juga sebagian besar fungsi yang telah kami tunjukkan memiliki sejumlah opsi penyesuaian yang mungkin berguna bagi Anda untuk membuat alat menghasilkan hal-hal yang paling sesuai dengan praktik tim Anda untuk penamaan, dll. Sistem konfigurasi bawaan yang tersedia juga dapat membantu Anda.

Saya harap Anda menemukan motivasi untuk memberi Lombok kesempatan untuk masuk ke perangkat pengembangan Java Anda. Cobalah dan tingkatkan produktivitas Anda!

Kode contoh dapat ditemukan di proyek GitHub.