“Checkstyle is a development tool t

“Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. It automates the process of checking Java code to spare humans of this boring (but important) task.”

As said by the developers of Checkstyle, this tool help you to define and maintain in a very precise and flexible way the coding standards of a project. When you launch Checkstyle, it will parse your Java code and will inform you about all the errors found according the configuration provided.

The Gradle way

The following code show you the basic configuration to use Checkstyle in your project (as a Gradle task) :

+ expand source
So, basically this task will analyse your code according to the checkstyle.xml and the suppressions.xml. To execute it through Android Studio, just launch the task checkstyle from the gradle panel :

checkstyle
How to execute your gradle task checkstyle
After running checkstyle, you will have a report describing each problem founded in your project. That’s pretty straightforward.

If you want to do more configurations on checkstyle, just refer to the documentation ;).

Tricks for checkstyle

Checkstyle will detect a huge amount of problems, especially if you use a lot of rules, like in the case you want a very precise syntax. Even if I use checkstyle through Gradle, for example before my pushs, I recommend you to also use the plugin checkstyle for IntellJ/Android Studio (you can directly install it from Android Studio through the panel File/Settings/Plugins). This way you will be able to apply checkstyle to your project according the same configs files as specified for Gradle, but more than that, you will have access to the results directly in Android Studio, with hyperlinks to the problems in your code, which is pretty useful (The Gradle way is still very important since you can use it through automated build system like Jenkins).

Findbugs



Presentation

Does Findbugs need a presentation? I guess the name is meaningful. “FindBugs uses static analysis to inspect Java bytecode for occurrences of bug patterns.” Findbugs basically just need the bytecode of a program to do the analysis, so it is very easy to use. It will detect common error such as wrong boolean operator. Findbugs is also able to detect error due to misunderstood of language features, such as reassignment of parameters in Java (which is not really possible since it parameters are passed by values).

The Gradle way

The following code show you the basic configuration for use Findbugs in your project (as a Gradle task) :

+ expand source
So it looks a lot like the Checkstyle task. Since Findbugs support HTML and XML reports, I pick the HTML since the report is more readable. Moreover, you just need to bookmark the report location to have a quick access to it. This task will also failed if an error in Findbgus is detected (still producing a report). To execute the Findbugs task, that’s exactly like for the Checkstyle task (except that the name of the task is “findbugs”).

Tricks for Findbugs

I strongly recommend to use a findbugs-filter, since Android project are slightly different from Java project. You can take example on this one (the one of the example project). It will basically ignore the R file and your Manifest file. By the way, since Findbugs analyse your bytecode, you need to compile at least one time your code to be able to test it.

PMD



Presentation

Funny fact of this tool : there is not a real name for PMD. On the offcicial website you will find very interesting names propositions as :

Pretty Much Done
Project Meets Deadline
In the facts, PMD is a very powerful tool which works a little bit like Findbugs, but inspect directly the source code, and not the bytecode (btw. PMD can work with plenty of languages). The goal is globally the same, find patterns which can lead to bugs using static analysis. So why use Findbugs and PMD at the same time ? Well, even if Findbugs and PMD share globally the same goals, their inspecting methods are different. So PMD can sometimes find bugs which Findbugs wont, and vice versa.

The Gradle way

The following code show you the basic configuration for use PMD in your project (as a Gradle task) :

+ expand source
For PMD, this is also almost the same as Findbugs. PMD can produce HTML or XML reports, so again I pick the HTML format. I strongly recommend you to use your own custom rulesets file as I’m doing in this example (check this file). So of course, take a look at the documentation about custom ruleset. I recommend you that because PMD can be a lot more controversial than Findbugs. For example, it will basically warn you if you not collapse “if statement”, or if you have empty “if statement”. I’m really thinking that’s the job of you and your teammates to define, if these rules are right, or not, for your project. I know I prefer to not collapse if statement since, I think this is a lot less readable. To execute the PMD task, that’s exactly like for the Checks

Kết quả (Việt) 1:

"Checkstyle là một công cụ phát triển để giúp các lập trình viên viết mã Java tuân thủ các tiêu chuẩn mã hóa. Nó tự động hóa quá trình kiểm tra Java code để phụ tùng con này nhàm chán (nhưng quan trọng) các nhiệm vụ."Như đã nói bởi nhà phát triển của Checkstyle, công cụ này giúp bạn xác định và duy trì trong một cách rất chính xác và linh hoạt các tiêu chuẩn mã hóa của một dự án. Khi bạn khởi động Checkstyle, nó sẽ phân tích cú pháp mã Java của bạn và sẽ thông báo cho bạn về tất cả các lỗi được tìm thấy theo cấu hình được cung cấp.Cách GradleCác mã sau đây cho bạn thấy các cấu hình cơ bản để sử dụng Checkstyle trong dự án của bạn (như là một nhiệm vụ Gradle):+ mở rộng nguồnVì vậy, về cơ bản nhiệm vụ này sẽ phân tích mã của bạn theo checkstyle.xml và suppressions.xml. Để thực hiện nó thông qua Android Studio, chỉ cần khởi động checkstyle nhiệm vụ từ bảng gradle:checkstyleLàm thế nào để thực hiện của bạn gradle nhiệm vụ checkstyleSau khi chạy checkstyle, bạn sẽ có một báo cáo mô tả từng vấn đề được thành lập trong dự án của bạn. Đó là khá dễ dàng.Nếu bạn muốn làm các cấu hình thêm vào checkstyle, chỉ cần tham khảo các tài liệu).Thủ thuật cho checkstyleCheckstyle sẽ phát hiện một số tiền rất lớn của vấn đề, đặc biệt là nếu bạn sử dụng rất nhiều quy tắc, giống như trong trường hợp bạn muốn có một cú pháp rất chính xác. Ngay cả khi tôi sử dụng checkstyle qua Gradle, ví dụ trước của tôi trong này, tôi khuyên bạn nên bạn cũng có thể sử dụng plugin checkstyle cho IntellJ/Android Studio (bạn có thể trực tiếp cài đặt nó từ Android Studio thông qua bảng điều khiển tập tin/cài đặt/Plugins). Bằng cách này bạn sẽ có thể áp dụng checkstyle cho các dự án của bạn theo các tập tin configs tương tự như quy định đối với Gradle, nhưng hơn thế nữa, bạn sẽ có quyền truy cập vào các kết quả trực tiếp trong Android Studio, với các siêu liên kết đến các vấn đề trong mã của bạn, mà là khá hữu ích (Gradle cách vẫn là rất quan trọng kể từ khi bạn có thể sử dụng nó thông qua hệ thống tự động xây dựng như Jenkins).FindbugsTrình bàyKhông Findbugs cần một bài trình bày? Tôi đoán tên có ý nghĩa. "FindBugs sử dụng tĩnh phân tích để kiểm tra Java bytecode cho lần xuất hiện của lỗi mẫu." Findbugs về cơ bản chỉ cần bytecode của một chương trình để làm phân tích, do đó, nó rất dễ dàng sử dụng. Nó sẽ phát hiện lỗi phổ biến như toán tử boolean sai. Findbugs cũng có thể phát hiện các lỗi do hiểu lầm trong tính năng ngôn ngữ, chẳng hạn như tái bố trí các thông số trong Java (đó là không thực sự có thể kể từ khi nó tham số được truyền bởi giá trị).Cách GradleCác mã sau đây cho bạn cấu hình cơ bản để sử dụng Findbugs trong dự án của bạn (như là một nhiệm vụ Gradle):+ mở rộng nguồnVì vậy, nó trông rất giống như nhiệm vụ Checkstyle. Kể từ khi Findbugs hỗ trợ HTML và XML báo cáo, tôi chọn HTML từ báo cáo là dễ đọc hơn. Hơn nữa, bạn chỉ cần đánh dấu vị trí bản báo cáo có một truy cập nhanh tới nó. Nhiệm vụ này sẽ không thành công nếu một lỗi trong Findbgus được phát hiện (vẫn còn sản xuất một báo cáo). Để thực hiện nhiệm vụ Findbugs, đó là chính xác giống như cho nhiệm vụ Checkstyle (ngoại trừ tên của nhiệm vụ là "findbugs").Thủ thuật cho FindbugsTôi đề nghị sử dụng một bộ lọc findbugs, kể từ khi dự án Android là một chút khác nhau từ dự án Java. Bạn có thể lấy ví dụ về điều này một (một trong những dự án ví dụ). Nó về cơ bản sẽ bỏ qua tập tin R và tập tin biểu hiện của bạn. Bằng cách này, do Findbugs phân tích bytecode của bạn, bạn cần phải biên dịch ít nhất một thời gian mã của bạn để có thể kiểm tra nó.PMDTrình bàyVui thực tế của công cụ này: không phải là một tên thật cho PMD. Trên trang web của offcicial, bạn sẽ tìm thấy các đề xuất tên gọi rất thú vị như:Khá nhiều thực hiệnDự án đáp ứng hạn chótTrong các sự kiện, PMD là một công cụ rất mạnh mẽ mà làm việc một chút giống như Findbugs, nhưng kiểm tra trực tiếp mã nguồn, và không phải là bytecode (btw. PMD có thể làm việc với nhiều ngôn ngữ). Mục tiêu toàn cầu là các mô hình tìm kiếm tương tự, có thể dẫn tới lỗi sử dụng phân tích tĩnh. Vậy tại sao sử dụng Findbugs và PMD cùng một lúc? Vâng, ngay cả khi Findbugs và PMD chia sẻ trên toàn cầu cùng một mục tiêu, phương pháp inspecting của họ là khác nhau. Vì vậy, PMD đôi khi có thể tìm thấy các lỗi đó wont Findbugs, và ngược lại.Cách GradleCác mã sau đây cho bạn cấu hình cơ bản để sử dụng PMD trong dự án của bạn (như là một nhiệm vụ Gradle):+ mở rộng nguồnCho PMD, đây cũng là gần như giống như Findbugs. PMD có thể sản xuất ra HTML hoặc XML báo cáo, vì vậy một lần nữa tôi nhận định dạng HTML. Tôi mạnh mẽ khuyên bạn nên sử dụng tập tin tùy chỉnh luật riêng của bạn như tôi đang làm trong ví dụ này (kiểm tra tập tin này). Như vậy tất nhiên, hãy xem tài liệu hướng dẫn về bộ quy tắc tuỳ chỉnh. Tôi khuyên bạn nên mà vì PMD có thể gây nhiều tranh cãi hơn Findbugs. Ví dụ, nó sẽ cơ bản cảnh báo bạn nếu bạn không sụp đổ "Nếu tuyên bố", hoặc nếu bạn có sản phẩm nào "Nếu tuyên bố". Tôi thực sự nghĩ đó là công việc của bạn và đồng đội của bạn để xác định, nếu các quy tắc này là đúng, hoặc không, cho dự án của bạn. Tôi biết tôi thích không sụp đổ nếu tuyên bố kể từ, tôi nghĩ rằng điều này là rất ít có thể đọc được. Để thực hiện nhiệm vụ PMD, mà là chính xác như để kiểm tra

Kết quả (Việt) 2:

"Checkstyle là một công cụ phát triển để giúp các lập trình viên viết mã Java mà tuân thủ một tiêu chuẩn mã hóa. Nó tự động hóa quá trình kiểm tra mã Java để phụ tùng con người nhàm chán này (nhưng quan trọng) nhiệm vụ. " Như đã nói bởi các nhà phát triển của Checkstyle, công cụ này giúp bạn xác định và duy trì một cách rất chính xác và linh hoạt các tiêu chuẩn mã hóa của một dự án . Khi bạn khởi động Checkstyle, nó sẽ phân tích mã Java của bạn và sẽ thông báo cho bạn về tất cả các lỗi được tìm thấy theo cấu hình cung cấp. Các Gradle cách Các mã sau đây cho bạn thấy cấu hình cơ bản để sử dụng Checkstyle trong dự án của bạn (như là một nhiệm vụ Gradle): + mở rộng nguồn Vì vậy, về cơ bản nhiệm vụ này sẽ phân tích mã của bạn theo checkstyle.xml và suppressions.xml. Để thực hiện nó thông qua Android Studio, chỉ cần khởi động checkstyle nhiệm vụ từ bảng gradle: CheckStyle Làm thế nào để thực hiện nhiệm vụ checkstyle gradle của bạn Sau khi chạy checkstyle, bạn sẽ có một báo cáo mô tả từng vấn đề thành lập trong dự án của bạn. Đó là khá đơn giản. Nếu bạn muốn làm nhiều cấu hình trên checkstyle, chỉ cần tham khảo các tài liệu hướng dẫn;). Tricks cho checkstyle Checkstyle sẽ phát hiện một số lượng lớn các vấn đề, ​​đặc biệt là nếu bạn sử dụng rất nhiều quy tắc, như trong trường hợp bạn muốn có một cú pháp rất chính xác. Ngay cả khi tôi sử dụng checkstyle qua Gradle, ví dụ trước pushs của tôi, tôi khuyên bạn cũng sử dụng checkstyle plugin cho IntellJ / Android Studio (bạn có thể cài đặt trực tiếp từ Android Studio thông qua các tập tin bảng / Settings / Plugins). Bằng cách này bạn sẽ có thể áp dụng checkstyle để dự án của bạn tùy theo cùng một file configs như quy định đối với Gradle, nhưng hơn thế nữa, bạn sẽ có quyền truy cập vào các kết quả trực tiếp trong Android Studio, với các siêu liên kết đến các vấn đề trong mã của bạn, đó là khá hữu ích (cách Gradle vẫn còn rất quan trọng vì bạn có thể sử dụng nó thông qua hệ thống tự động xây dựng như Jenkins). FindBugs Presentation có FindBugs cần trình bày? Tôi đoán tên có ý nghĩa. "FindBugs sử dụng phân tích tĩnh để kiểm tra Java bytecode cho lần xuất hiện của mô hình lỗi." FindBugs cơ bản chỉ cần bytecode của một chương trình để làm phân tích, vì thế nó rất dễ dàng để sử dụng. Nó sẽ phát hiện lỗi thông thường như điều hành boolean sai. FindBugs cũng có thể phát hiện lỗi do hiểu lầm về tính năng ngôn ngữ, chẳng hạn như tái chỉ định các tham số trong Java (đó là không thực sự tốt vì nó thông số được truyền theo giá trị). Cách Gradle Các mã sau đây cho bạn thấy cấu hình cơ bản cho FindBugs sử dụng trong dự án của bạn (như là một nhiệm vụ Gradle): + mở rộng nguồn vì vậy, nó trông rất giống các nhiệm vụ Checkstyle. Kể từ khi hỗ trợ HTML và XML báo cáo FindBugs, tôi chọn HTML từ báo cáo là dễ đọc hơn. Hơn nữa, bạn chỉ cần đánh dấu các vị trí báo cáo để có thể truy cập nhanh đến nó. Công việc này cũng sẽ thất bại nếu một lỗi trong Findbgus được phát hiện (vẫn còn sản xuất một báo cáo). Để thực hiện nhiệm vụ FindBugs, đó là chính xác như cho công việc Checkstyle (trừ tên của nhiệm vụ là "FindBugs"). Tricks cho FindBugs tôi khuyên các bạn nên sử dụng một FindBugs lọc, kể từ khi dự án Android hơi khác với các dự án Java. Bạn có thể lấy một ví dụ về điều này một (một trong những dự án ví dụ). Về cơ bản nó sẽ bỏ qua các tập tin R và tập tin Manifest của bạn. Bằng cách này, kể từ FindBugs phân tích bytecode của bạn, bạn cần phải biên dịch ít nhất một lần mã của bạn để có thể kiểm tra nó. PMD Presentation vui thực tế của công cụ này: không có một tên thực sự cho PMD. Trên trang web offcicial bạn sẽ tìm thấy tên rất thú vị các mệnh đề như: khá nhiều Xong dự án Meets Hạn Trong các sự kiện, PMD là một công cụ rất mạnh mẽ mà làm việc một chút như FindBugs, nhưng kiểm tra trực tiếp các mã nguồn, và không phải là bytecode (btw . PMD có thể làm việc với nhiều ngôn ngữ). Mục đích là trên toàn cầu như nhau, tìm thấy các mẫu có thể dẫn đến lỗi sử dụng phân tích tĩnh. Vì vậy, tại sao sử dụng FindBugs và PMD cùng một lúc? Vâng, ngay cả nếu FindBugs và PMD chia sẻ trên toàn cầu cùng mục tiêu, phương pháp thanh tra của họ là khác nhau. Vì vậy, PMD đôi khi có thể tìm thấy lỗi mà FindBugs wont, và ngược lại. Các Gradle cách Các mã sau đây cho bạn thấy cấu hình cơ bản để sử dụng PMD trong dự án của bạn (như là một nhiệm vụ Gradle): + mở rộng nguồn Đối với PMD, đây cũng là gần như giống nhau như FindBugs. PMD có thể sản xuất các báo cáo HTML hay XML, do đó một lần nữa tôi nhận định dạng HTML. Tôi đề nghị bạn sử dụng rulesets tùy chỉnh riêng của tập tin của bạn như tôi đang làm trong ví dụ này (kiểm tra tập tin này). Vì vậy, tất nhiên, hãy xem xét các tài liệu về Bộ quy tắc tùy chỉnh. Tôi khuyên bạn rằng vì PMD có thể có rất nhiều tranh cãi hơn FindBugs hơn. Ví dụ, nó về cơ bản sẽ cảnh báo bạn nếu bạn không sụp đổ "if", hoặc nếu bạn có sản phẩm nào "if". Tôi thực sự nghĩ đó là công việc của bạn và đồng đội của mình để xác định, nếu các quy tắc là đúng, hay không, đối với dự án của bạn. Tôi biết tôi thích để không sụp đổ nếu tuyên bố kể từ đó, tôi nghĩ rằng đây là ít hơn rất nhiều có thể đọc được. Để thực hiện nhiệm vụ PMD, đó là chính xác như cho Checks