Techniken zum Lesen von Java-Quellcode in Eclipse

Einführung

Sie haben die Möglichkeit, den von anderen Projektmitgliedern geschriebenen Quellcode zu lesen, den Quellcode zu lesen, um das von Ihnen verwendete Framework zu untersuchen, und den Quellcode in verschiedenen Situationen zu lesen.

In einem solchen Fall gibt es verschiedene Ansätze, um die Funktionen der IDE zu verwenden, das Schlaggefühl zu verbessern, die Tastaturbedienung schneller zu trainieren und so weiter.

In diesem Artikel konzentrieren wir uns auf die Verwendung der Funktionen der IDE aus diesen Ansätzen und stellen die Funktionen vor, die zum Lesen des Quellcodes nützlich sind, wenn die Sprache Java ist und die IDE Eclipse verwendet.

Lesen Sie den Java-Quellcode in Eclipse

Aus Gründen der Übersichtlichkeit werden einige Screenshots veröffentlicht, der dort angezeigte Quellcode stammt jedoch aus einer Datenbankzugriffsbibliothek namens Doma. (Ganz mein Hobby)

Da mein Körper von Eclipse verflucht ist, werde ich auch über die Funktionen von Eclipse schreiben, aber ich denke, dass es ähnliche in anderen IDEs gibt. Wenn Sie also eine andere IDE verwenden, wäre ich Ihnen dankbar, wenn Sie einen Artikel mit dem Titel "Diese IDE sollte dies tun" schreiben könnten.

Zur Definition springen

Zunächst von den Grundlagen. Wenn Sie den Quellcode lesen und von dem Code, der die Methode aufruft, zu dem Punkt springen möchten, an dem die Methode definiert ist, setzen Sie den Cursor auf den Code, der die Methode aufruft, und drücken Sie "F3".

Setzen Sie den Cursor auf
<img width = "212" alt = "Screenshot 2017-12-09 12.18.29.png " src = "https://qiita-image-store.s3.amazonaws.com" /0/19129/029b3929-3386-a774-448f-3174aad83b85.png ">
Drücken Sie F3
<img width =" 374 "alt =" Screenshot 2017-12-09 12.18.45.png "src =" https: //qiita-image-store.s3.amazonaws. com / 0/19129 / d7bc5f85-f586-d8b7-5849-b819cfd1ddfc.png ">

Wenn Sie einen bestimmten Prozess von Anfang an lesen, springen Sie häufig zur Methodendefinition. Ich denke, dies ist eine Funktion, die Sie häufig verwenden.

Wechseln Sie zur Methodendefinition der Schnittstellenimplementierungsklasse

Wenn Sie mit F3 zur Methodendefinition springen, gibt es möglicherweise keine Implementierung in der Schnittstelle darüber hinaus.

Wenn Sie mit F3 zur Methodendefinition springen ...
<img width =" 372 "alt =" Screenshot 2017-12-09 13.20.31.png "src =" https: // qiita-image -store.s3.amazonaws.com/0/19129/50f5e84c-ca74-5f22-7c85-d4e9f1973611.png ">
Es gibt keine Implementierung in der Schnittstelle!
<img width = "194" alt = "Screenshot 2017-12-09 13.20.41.png " src = "https://qiita-image-store.s3.amazonaws.com/0/19129/2810c866" -6505-80af-60c0-08fbd644155d.png ">

Setzen Sie in diesem Fall den Cursor auf den Methodenaufrufcode und drücken Sie Befehl + T. Dann wird eine Liste der Klassen angezeigt, die die Methode implementieren. Das ist es also! Wählen Sie die gewünschte Klasse aus und springen Sie zur Methodendefinition.

Setzen Sie den Cursor auf den Methodenaufrufcode
<img width = "372" alt = "Screenshot 2017-12-09 13.20.31.png " src = "https: //qiita-image-store.s3" .amazonaws.com / 0/19129 / 50f5e84c-ca74-5f22-7c85-d4e9f1973611.png ">
Drücken Sie Command + T
<img width =" 415 "alt =" Screenshot 2017-12-09 13.21.11.png "src =" https: //qiita-image-store.s3. amazonaws.com/0/19129/3fabe6c7-6855-064d-a8df-a29d31367f66.png ">
Sie können zur Methodendefinition springen, indem Sie die Implementierungsklasse auswählen.
<img width = "239" alt = "Screenshot 2017-12-09 13.21.19.png " src = "https: // qiita-image-store" .s3.amazonaws.com / 0/19129 / 983b8677-bc3e-a1f0-4e61-3acb34d8479b.png ">

In diesem Beispiel wird nur eine Klasse angezeigt, in einigen Fällen werden jedoch viele Implementierungsklassen angezeigt. Unter ihnen ist es das! Die Wahl einer Klasse, die so aussieht, als ob sie Wissen und Sinn erfordert, aber sie zu trainieren, ist eine andere Geschichte, deshalb werde ich sie weglassen.

Finden Sie heraus, wo Sie eine Methode aufrufen können

Möglicherweise möchten Sie wissen, wo eine Methode aufgerufen wird, wenn Sie die Auswirkungen von Spezifikationsänderungen untersuchen. Setzen Sie in diesem Fall den Cursor auf die zu untersuchende Methodendefinition und drücken Sie "Strg + Alt + H". Anschließend wird eine Liste der Orte angezeigt, an denen die Methode aufgerufen wird.

Wenn Sie die Dreiecksmarkierung links neben jedem Element in der Liste der Anrufpunkte drücken, werden die Anrufpunkte dieser Methode in einer Liste angezeigt.

Auf diese Weise können Sie in der aufrufenden Hierarchie hin und her gehen.

Suchen Sie nach Klassenreferenzen

Platzieren Sie den Cursor auf der Klasse und drücken Sie "Befehl + Umschalt + G". Dann werden die Orte aufgelistet, die sich auf diese Klasse beziehen.

Wenn die Klasse als Feld referenziert wird, wird der Feldname angezeigt, und wenn sie als Argument / lokale Variable referenziert wird, wird der Konstruktorname oder Methodenname in den Suchergebnissen angezeigt.

Diese Funktion wurde benötigt, wenn ich ein Framework mit angemessener Größe wie Spring Boot gelesen habe.

Andere häufig verwendete Suchfunktionen

Abgesehen von diesen verwende ich häufig die Typensuche und die Ressourcensuche.

Geben Sie search mit Command + Shift + T ein (sucht in JAR)
Suche nach Ressourcen mit Befehl + Umschalt + R (sucht nicht in JAR)

In meinem Fall werden diese meiner Meinung nach beim Schreiben des Quellcodes häufiger verwendet als beim Lesen des Quellcodes.

Andere Tools als Eclipse

Neben Eclipse gibt es noch andere Tools, mit denen Sie den Quellcode lesen können. Hier werde ich nur eine kurze Einführung als Bonus geben.

Git

Ich benutze oft git grep und git ls-files. In git grep werden die Option -i und die Option -name-only häufig zusammen verwendet.

Große Projekte wie das Spring Framework müssen häufig zur Suche in Eclipse importiert werden.

unite.vim

unite.vim ist ein Vim-Plug-In, das verschiedene Dinge wie Dateien und Puffer als Datenquellen durchsuchen kann. Es ist äußerst praktisch, aber ich habe ein kleines Problem, weil es auf dem PC meines Unternehmens nicht funktioniert. Ich habe etwas zu erledigen ...

Unite.vim befindet sich übrigens im Wartungsmodus und der Nachfolger ist denite.nvim. Ich muss verändern ...

abschließend

Ich habe die Funktionen vorgestellt, die zum Lesen des Quellcodes mit Java und Eclipse als Betreff nützlich sind, aber wie war es? Wie bereits erwähnt, denke ich, dass andere IDEs ähnliche Funktionen (oder bequemere Funktionen) haben. Lesen Sie daher bitte das Handbuch Ihrer IDE oder fragen Sie die Experten in Ihrer Nähe.

Dieses Mal habe ich die Funktionen von Eclipse speziell geschrieben, aber ich hoffe, ich kann die Denkweise beim Lesen des Quellcodes und andere Ansätze, die zum Lesen des Quellcodes zu einem anderen Zeitpunkt verwendet werden können, ankündigen. Ich bin.

Dann haben alle ein gutes Quellcode-Leseleben!