Nghỉ giải lao #86. Hướng dẫn nhanh chóng và dễ dàng để định dạng lại mã trong IntelliJ IDEA

Nguồn: Lightrun Là một nhà phát triển, bạn sẽ phải thực hiện các thay đổi đối với cơ sở mã. Và nếu cơ sở mã không được định dạng rõ ràng thì việc gỡ lỗi sẽ trở nên khó khăn hơn nhiều đối với bạn. Những thay đổi nhỏ như định dạng lại và thụt lề thích hợp trong mã thường bị bỏ qua, nhưng rõ ràng chúng giúp phân biệt cơ sở mã của nhà phát triển chuyên nghiệp với cơ sở mã của người mới bắt đầu. Việc duy trì định dạng và thụt lề mã thích hợp sẽ giúp bạn viết mã dễ đọc hơn. Điều này giúp đơn giản hóa việc cộng tác trên các dự án, tăng tốc độ gỡ lỗi và duy trì cơ sở mã. Mã trở nên dễ đọc và có cấu trúc hơn. Có thể tăng tốc quá trình định dạng lại mã? Bài viết này sẽ giới thiệu cho bạn một phương pháp đơn giản để tự động định dạng lại mã bằng IntelliJ IDEA. Bạn sẽ tìm hiểu cách giảm thời gian cần thiết cho quy trình này và bạn cũng sẽ tìm hiểu cách loại trừ các phần của cơ sở mã khỏi việc định dạng lại bằng các phím tắt khác nhau.

Lợi ích của việc định dạng lại

Điều quan trọng cần nhớ là không cần phải định dạng hoặc mã nhận xét để chức năng này hoạt động. Bất kỳ mã nào, có hoặc không có định dạng, đều có thể được trình biên dịch đọc và thực thi đầy đủ. Mặt khác, việc định dạng lại giúp mọi người dễ đọc đánh dấu hơn nhiều. Đối với trình biên dịch, tất cả những gì quan trọng là mã hoạt động và nó không chứa lỗi cũng như không phải nó tốt hay thụt lề đẹp như thế nào. Đúng, điều sau khiến mọi người lo lắng vì họ phải đọc những đoạn mã như vậy. Cũng giống như văn bản thuần túy, không ai thích đọc nội dung không có hình thức mà không có tiêu đề, đoạn văn hoặc bất kỳ sự thụt lề nào. Một số kỹ thuật định dạng lại cần thiết bao gồm:

• Thụt lề.
• Phong cách và chức năng viết.
• Không gian trống rỗng.
• Sử dụng chữ in hoa và tên.

Gỡ lỗi là điều cần thiết mà một nhà phát triển sẽ gặp phải thường xuyên trong suốt sự nghiệp của họ. Bắt đầu từ đâu nếu cơ sở mã của bạn lộn xộn và vô tổ chức? Khi mã nguồn được định dạng và thụt lề đúng cách, nó sẽ ít bị phân cụm hơn. Điều này giúp dễ dàng xác định vị trí của các mô-đun ứng dụng khác nhau. Do đó, việc tìm ra các vấn đề và lỗi trở nên dễ dàng hơn. Việc định dạng lại mã trong IntelliJ IDEA dựa trên các yêu cầu được chỉ định trong cài đặt kiểu mã trong IDE. Mặc dù, khi bạn sử dụng EditorConfig trong dự án của mình, các cài đặt bạn chỉ định trong tệp .editorconfig theo mặc định sẽ ghi đè những cài đặt được chỉ định trong cài đặt kiểu mã. Việc định dạng lại trong IntelliJ không khác gì làm việc trong các IDE khác. Có các tùy chọn để định dạng lại cả một khối mã và toàn bộ tệp. Có thể đôi khi toàn bộ khối mã của bạn khá dài và bạn muốn mọi thứ được định dạng lại ngoại trừ một số khu vực cụ thể. Trong trường hợp này, việc chọn riêng từng phần mã mà bạn muốn định dạng chắc chắn không phải là lựa chọn tốt nhất. Trong những tình huống như vậy, việc định dạng lại bằng IntelliJ chắc chắn sẽ có ích. Chúng ta sẽ khám phá điều này và những cách sử dụng khác của IDE.

Mẹo định dạng mã

Hãy xem xét một số mẹo cơ bản để định dạng mã nói chung:

• Hãy chắc chắn rằng mã của bạn được nhận xét đúng. Sử dụng nhận xét để truyền đạt ý định và ý nghĩa. Ngay cả khi bạn là người duy nhất đọc mã này, việc nhắc nhở bản thân về mục đích của một số khối mã nhất định vẫn rất hữu ích. Ví dụ: điều này sẽ giúp mọi việc dễ dàng hơn nếu bạn quay lại cơ sở mã của mình sau một kỳ nghỉ.

• Không sử dụng tab cho khoảng trắng trên cùng một dòng. Điều này làm giảm khả năng đọc của mã.

• Thêm TODO vào khối mã của bạn để theo dõi quá trình triển khai trong tương lai. Bằng cách này, khi bạn định dạng lại mã của mình, nó sẽ không tạo ra ảo tưởng rằng công việc của bạn đã hoàn tất.

• Không sử dụng định dạng lại mã như một cách sửa nhanh các lỗi cú pháp.

• Tránh đầu tư sâu Đây là cách làm phổ biến của một số nhà phát triển, nhưng mã được lồng sâu khiến mã khó đọc và gây ra các lỗi khó phát hiện ngay từ cái nhìn đầu tiên.

Mã định dạng lại trong IntelliJ IDEA

Trước khi chúng ta khám phá các cách khác nhau để định dạng mã trong IntelliJ, hãy bắt đầu bằng cách tạo một dự án Java mẫu trong IDE của bạn. Sau khi khởi chạy IntelliJ, bạn sẽ thấy một màn hình như thế này: Nhấp vào Tiếp theo và hoàn tất thiết lập khởi tạo dự án. Bây giờ dự án của bạn đã được thiết lập, đã đến lúc thêm mã mẫu để giúp bạn hiểu cách định dạng lại mã trong IntelliJ. Đây là một bộ đếm từ đơn giản của Đại học Texas:

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.Scanner;
import java.util.TreeMap;

public class SimpleWordCounter {

    public static void main(String[] args) {
        try {
            File f = new File("ciaFactBook2008.txt");
            Scanner sc;
            sc = new Scanner(f);
            // sc.useDelimiter("[^a-zA-Z']+");
            Map<String, Integer> wordCount = new TreeMap<String, Integer>();
            while(sc.hasNext()) {
                String word = sc.next();
                if(!wordCount.containsKey(word))
                    wordCount.put(word, 1);
                else
                    wordCount.put(word, wordCount.get(word) + 1);
            }

            // show results
            for(String word : wordCount.keySet())
                System.out.println(word + " " + wordCount.get(word));
            System.out.println(wordCount.size());
        }
        catch(IOException e) {
            System.out.println("Unable to read from file.");
        }
    }
}

Định dạng lại đoạn mã

Hãy bắt đầu bằng cách định dạng các đoạn mã. Để thực hiện việc này, chỉ cần đánh dấu phần mã bạn muốn định dạng và nhấp vào Code > Reformat Code . Như bạn có thể thấy, phần được đánh dấu trong mã của bạn (trong trường hợp này là dòng 11-17) được định dạng chính xác. Hãy xem “trước” và “sau” khi định dạng lại đoạn mã của chúng tôi. Nếu bạn nhận thấy trong hình ảnh đầu tiên, việc khai báo và khởi tạo biến của bạn diễn ra trên cùng một dòng với try . Các dấu ngoặc nhọn đóng được trộn lẫn với khối else . Nhưng sau khi đánh dấu phần mã này và sử dụng tùy chọn định dạng lại, bạn sẽ có được một khối mã đẹp mắt hơn. Mã hoàn chỉnh cho lớp của bạn bây giờ trông giống như thế này: Lưu ý rằng chỉ khối mã bạn chọn mới được định dạng lại.

Định dạng lại toàn bộ tập tin

Để định dạng lại toàn bộ tệp, hãy mở trình chỉnh sửa, đặt con trỏ ở bất kỳ đâu và nhấp vào Code >Reformat File . Bạn sẽ được nhắc chọn các tùy chọn định dạng lại thích hợp cho toàn bộ tệp. Hành động này sẽ định dạng lại tất cả mã của bạn trong trình chỉnh sửa đang hoạt động. Mã của bạn sẽ trở thành một cái gì đó như thế này:

Định dạng lại một mô-đun hoặc thư mục

Để thực hiện việc này, tất cả những gì bạn cần làm là nhấp chuột phải vào mô-đun trong cửa sổ công cụ dự án và chọn Mã định dạng lại . Trong cửa sổ bật lên, chọn bất kỳ tùy chọn nào trong ba tùy chọn bạn cần:

• Tối ưu hóa nhập khẩu : Chọn tùy chọn này nếu bạn muốn thêm các câu lệnh nhập bị thiếu và cũng loại bỏ các mục nhập không sử dụng.

• Sắp xếp lại các mục : Để sắp xếp lại mã theo quy tắc bố cục được chỉ định trong cài đặt kiểu mã.

• Mã dọn dẹp : để chạy mã dọn dẹp.

Khi bạn hoàn tất, chỉ cần nhấp vào OK.

Loại trừ mã khỏi định dạng lại

Hãy xem phải làm gì nếu bạn có một khối mã không muốn đưa vào khi định dạng toàn bộ tệp. Đi tới Tệp > Cài đặt hoặc sử dụng phím tắt Ctrl + Alt + S. Đi tới Trình chỉnh sửa > Kiểu mã và chọn Bật dấu định dạng trong menu nhận xét trên tab Kiểm soát định dạng . Trong trình chỉnh sửa của bạn, hãy tạo một nhận xét dòng và nhập //@formatter:off không có dấu ngoặc kép ở đầu vùng bạn muốn loại trừ. Ở cuối khu vực, tạo một dòng nhận xét khác và nhập //@formatter:on , cũng không có dấu ngoặc kép. Trong hình ảnh trên, bạn có thể thấy rằng trình định dạng sẽ bỏ qua mã của bạn ở dòng 23 chỉ vì bạn đã chỉ định nó trong phần nhận xét và bộ điều khiển định dạng.

Ví dụ về các phím nóng để định dạng lại

• Định dạng lại khối mã: Ctrl + Alt + Shift + L
• Định dạng lại tập tin: Ctrl + Alt + L
• Thêm chú thích vào dòng: Ctrl + /
• Thêm khối bình luận: Ctrl + Shift + /

Phần kết luận

Đối với nhà phát triển, việc chú ý đến các định dạng mã cũng quan trọng như việc làm cho nó hoạt động. Bạn không bao giờ có thể biết ai sẽ làm việc với mã của bạn. Việc có một cơ sở mã có cấu trúc tốt, dễ đọc nói lên một nhà phát triển chuyên nghiệp. Với IntelliJ IDEA, việc định dạng mã của bạn không còn khó khăn như việc viết mã. Lần tới khi bạn viết mã bằng IntelliJ, hãy sử dụng các mẹo này. Điều này sẽ giúp cuộc sống của bạn dễ dàng hơn khi gỡ lỗi mã.