JavaRush /Java Blog /Random-ID /Cara menulis metode secara efektif (terjemahan artikel)
pena
Level 41
Москва

Cara menulis metode secara efektif (terjemahan artikel)

Dipublikasikan di grup Random-ID
Artikel aslinya ada di: http://www.javacodegeeks.com/2015/09/how-to-write-methods- Effectively.html#download tutorial Diterbitkan oleh: Andrey Redko (Andrey Redko) di Core Java (Java Core) 18 September 2015 Catatan ini adalah bagian dari kursus Java Tingkat Lanjut di Akademi kami. Kursus ini dirancang untuk membantu Anda menggunakan Java dengan lebih efektif. Topik lebih lanjut dibahas di sini, seperti pembuatan objek, paralelisasi, serialisasi, refleksi, dan banyak lagi. Pengetahuan ini akan memandu perjalanan Anda menuju puncak penguasaan Java.
Isi Kursus
1. Pendahuluan 2. Tanda tangan metode 3. Isi metode 4. Kelebihan metode 5. Penggantian metode 6. Inlining 7. Rekursi 8. Referensi metode 9. Kekekalan 10. Dokumentasi metode 11. Parameter metode dan nilai kembalian 12. Metode sebagai titik masuk ke Lampiran 13. Langkah selanjutnya 14. Mengunduh kode sumber
1. Perkenalan
Di bagian tutorial ini, kita akan meluangkan waktu untuk membahas berbagai aspek terkait perancangan dan implementasi metode di Java. Pada bagian tutorial sebelumnya, Anda dapat melihat bahwa menulis metode di Java sangatlah mudah, namun ada banyak hal yang dapat membuat metode Anda lebih mudah dibaca dan efisien.
2. Metode tanda tangan
Seperti yang sudah Anda ketahui, Java adalah bahasa berorientasi objek. Pada dasarnya, setiap metode Java adalah milik beberapa bagian dari suatu kelas (atau kelas itu sendiri dalam kasus metode statistik). Ia mempunyai aturan visibilitas (atau aksesibilitas), dapat dinyatakan abstrak atau final, dan seterusnya. Namun, mungkin bagian yang paling penting dari sebuah metode adalah tanda tangannya: tipe kembalian dan argumen, ditambah daftar pengecualian yang diperiksa dari setiap implementasi metode yang dapat dilemparkan (tetapi bagian ini tidak sering digunakan di masa lalu, dan bahkan lebih jarang lagi saat ini. ). Mari kita mulai dengan contoh kecil. 1 public static void main( String[] args ) { 2 // Some implementation here 3 } Metode utama mengambil array string hanya sebagai argumen args dan tidak mengembalikan apa pun. Akan sangat menyenangkan untuk membuat semua metode sesederhana yang utama. Namun kenyataannya, tanda tangan metode mungkin tidak dapat dibaca. Mari kita lihat contoh berikut: 1 public void setTitleVisible( int lenght, String title, boolean visible ) { 2 // Some implementation here 3 } Hal pertama yang Anda perhatikan di sini adalah bahwa konvensi tersebut secara asli digunakan dalam nama metode Java, seperti setTitleVisible. Nama tersebut dipilih dengan baik dan mencoba menjelaskan apa yang seharusnya dilakukan oleh metode tersebut. Kedua, nama-nama argumen menjelaskan (atau setidaknya memberi petunjuk) apa tujuannya. Sangat penting untuk menemukan nama yang benar dan bermakna untuk argumen metode, daripada int i, String s, boolean f (namun, dalam kasus yang sangat jarang, hal ini masuk akal). Ketiga, metode ini hanya memiliki tiga argumen. Meskipun Java memiliki batas lebih tinggi dalam jumlah argumen yang diperbolehkan, sangat disarankan untuk tidak melebihi jumlah argumen lebih dari 6. Melebihi batas ini membuat tanda tangan sulit untuk dipahami. Sejak Java 5 dirilis, metode dapat memiliki daftar argumen berbeda dengan tipe yang sama (disebut varargs) dan menggunakan sintaksis khusus, misalnya: 1 public void find( String … elements ) { 2 // Some implementation here 3 } Secara internal, kompiler Java mengubah argumen variabel menjadi array dengan tipe yang sesuai dan dengan demikian argumen variabel dapat diubah. diadopsi untuk menerapkan metode tersebut. Menariknya, Java juga memungkinkan Anda mendeklarasikan vararg menggunakan parameter generik. Namun, karena tipe argumennya tidak diketahui, kompiler Java ingin memastikan bahwa varargs digunakan dengan benar dan menyarankan metode akhir untuk dianotasi dengan @SafeVarargs (untuk informasi lebih lanjut, lihat Bagian 5 dari tutorial, Bagaimana dan kapan menggunakan Enum dan Anotasi).Kami menggunakan Enumerasi dan Komentar) Misalnya: 1 @SafeVarargs 2 final public< T > void find( T ... elements ) { 3 // Some implementation here 4 } Другой ближайший путь это использовать @SuppressWarnings комментарии, например 1 @SuppressWarnings( "unchecked" ) 2 public< T > void findSuppressed( T ... elements ) { 3 // Some implementation here 4 } Следующий пример демонстрирует использование проверки исключений How части сигнатуры метода. В недалеком прошлом проверка исключений показала себя не настолько полезной, Howой она предполагалась быть, в результате шаблонный code был использован скорее для записи, чем для решения проблем. 1 public void write( File file ) throws IOException { 2 // Some implementation here 3 } Последнее, но, тем не менее, важное, How правило, рекомендуется (но редко используется), отметить аргументы метода, How final. Это поможет избавиться от практики написания плохого codeа, когда аргументы метода предназначены различным значениям. Кроме того, такие аргументы метода могут быть использованы анонимными классами (подробнее об анонимных классов рассматривается в части 3 учебника, , How to design Classes and Interfaces (Как проектировать Классы и Интерфейсы)), хотя Java 8 облегчила немного это ограничение путем введения эффективных final переменных.
3. Тело метода
Каждый метод имеет свою реализацию и цель существования. Однако, имеется пара общих рекомендаций которые реально помогают написанию ясных и понятных методов. Вероятно, наиболее важный принцип - это принцип единичной ответственности: нужно пытаться реализовать метод таким путем, чтобы каждый единичный метод делал что-то одно, и делал это хорошо. Следуя этому принципу возможно раздувание количества методов класса, и важно найти правильный баланс. Другая важная вещь в процессе codeирования и проектирования - это делать реализуемые методы короткими. Для коротких методов легко понять причину, по которой они сделаны, плюс они обычно умещаются на экран, и таким образом могут быть очень быстро поняты читателем вашего codeа. Последний по порядку (но не по значению) совет связан с использованием return операторов. Если метод возвращает некоторое meaning, пытайтесь минимизировать число мест, где return meaning было бы вызвано (некоторые люди идут даже дальше и рекомендуют использовать лишь единичное return meaning во всех случаях. Чем больше return значений имеет метод, тем более тяжело становится следовать его логике и модифицировать (or оптимизировать) реализацию.
4. Перегрузка метода
Техника перегрузки методов часто используется, чтобы обеспечить специализацию версий метода для различных типов аргументов or их комбинаций. Хотя Name метода одинаковое компьютер выбирает правильную альтернативу, углубляясь в текущие значения аргументов в точке вызова (лучший пример перегрузки это конструкторы Java: Name всегда одинаковое, но аргументы разные) or вызывает ошибку компилятора, если такой вариант метода не найден. Например: 1 public String numberToString( Long number ) { 2 return Long.toString( number ); 3 } 4 5 public String numberToString( BigDecimal number ) { 6 return number.toString(); 7 } Перегрузка метода отчасти близка к дженерикам (больше информации о дженериках можно найти в части 4 учебника How and when to use Generics (Как и когда использовать дженерики)), однако перегрузка используется в случае, где подход с использованием дженериков не работает хорошо и каждый or большинство типов аргументов, которые являются дженериками, требуют своих собственных специализированных реализаций. Тем не менее, комбинируя оба способа дженерики и перегрузку можно быть очень производительным, но часто это невозможно в Java, потому что тип стирается (больше информации в части 4 учебника How and when to use Generics (Как и когда использовать дженерики)). Давайте взглянем на пример: 1 public< T extends Number > String numberToString( T number ) { 2 return number.toString(); 3 } 4 5 public String numberToString( BigDecimal number ) { 6 return number.toPlainString(); 7 } Хотя этот кусок codeа мог быть написан без использования дженериков, это неважно для наших демонстрационных целей. Интересно, что метод numberToString перегружен специальной реализацией BigDecimal и version на дженериках предназначена для всех остальных чисел.
5. Переопределение метода
Мы много говорor о переопределении методов в части 3 учебника (How to design Classes and Interfaces (Как проектировать классы и интерфейсы). В этом разделе, когда мы уже знаем о перегрузке методов, мы собираемся показать, почему использование @Override аннотации так важно. Наш пример продемонстрирует тонкое различие между переопределением метода и перегрузкой метода в простой иерархии классов. 1 public class Parent { 2 public Object toObject( Number number ) { 3 return number.toString(); 4 } 5 } Родительский класс имеет только один метод toObject. Давайте создадим подкласс этого класса и попытаемся придумать версию метода преобразования чисел в строки (instead of необработанных an objectов). 1 public class Child extends Parent { 2 @Override 3 public String toObject( Number number ) { 4 return number.toString(); 5 } 6 } Тем не менее, сигнатура метода toObject в дочернем классе немногим отличается (см Covariant method return types (Ковариантные типы возвращаемые методами) для более подробной информации), и это делает переопределение его из суперкласса в свой класс, при этом компилятор Java не выдает ниHowих ошибок и предупреждений. Теперь, давайте добавим еще один метод к дочернему классу. 1 public class Child extends Parent { 2 public String toObject( Double number ) { 3 return number.toString(); 4 } 5 } Опять же, есть только небольшая разница в сигнатуре метода (Double instead of Number), но то, что в данном случае это перегруженная version метода, не отменяет переопределения метода родителя. То есть, когда подсказка от компилятора Java и @Override аннотации перекрываются: метод с аннотацией из последнего примера с @Override вызовет ошибку компилятора.
6. Встраивание
Встраивание - это оптимизация, осуществляемая с помощью Java JIT (точно в срок) компилятора для того, чтобы устранить конкретный вызов метода и заменить его непосредственно реализацией метода. Использование компилятора JIT эвристики зависит от двух вещей - How часто метод вызывается в настоящее время, а также от того, насколько он большой. Методы, которые слишком велики, не могут быть эффективно встроены. Встраивание может обеспечить значительный прирост производительности codeа и преимущество хранения методов короткими, How мы уже обсуждали в разделе Method body (Тело метода).
7. Рекурсия
Рекурсия в Java - это техника, где метод вызывает сам себя, выполняя расчеты. Например, давайте взглянем на следующий пример, который суммирует число массива: 1 public int sum( int[] numbers ) { 2 if( numbers.length == 0 ) { 3 return 0; 4 } if( numbers.length == 1 ) { 5 return numbers[ 0 ]; 6 } else { 7 return numbers[ 0 ] + sum( Arrays.copyOfRange( numbers, 1, numbers.length ) ); 8 } 9 } Это очень неэффективная реализация, однако она демонстрирует рекурсию достаточно хорошо. Существует одна хорошо известная проблема с рекурсивными методами: в зависимости, насколько глубока цепь вызовов, они могут переполнить стек и вызвать исключение StackOverflowError. Но не все так плохо, How кажется, потому что есть техника, которая может устранить переполнение стека, называемая tail call optimization (оптимизация хвоста вызова). Она может быть применена, если метод с хвостовой рекурсией (методы с хвостовой рекурсией это методы, в которых все рекурсивные вызовы это хвостовые вызовы). Например, давайте перепишем предыдущий алгоритм с использованием в хвостовой рекурсии: 01 public int sum( int initial, int[] numbers ) { 02 if( numbers.length == 0 ) { 03 return initial; 04 } if( numbers.length == 1 ) { 05 return initial + numbers[ 0 ]; 06 } else { 07 return sum( initial + numbers[ 0 ], 08 Arrays.copyOfRange( numbers, 1, numbers.length ) ); 09 } 10 } К сожалению, на данный момент компилятор Java (а также компилятор JVM JIT) не поддерживает tail call optimization хвостовую оптимизация, но все-таки это очень полезная техника, и ее надо знать и принимать во внимание, когда вы пишете рекурсивные алгоритмы в Java.
8. Ссылки методов
В Java 8 сделан огромный шаг вперед, путем введения функциональных понятий в язык Java. Основание, которое трактует методы How данные, понятие, которое не поддерживалось в языке до этого (однако, с тех пор How выпущена Java 7, JVM и стандартная библиотека Java уже были некоторые наработки, чтобы сделать это возможным). К счастью, имея ссылки методов, теперь это возможно. Ссылка статического метода: SomeClass::staticMethodName Ссылка на метод экземпляра конкретного an object: someInstance::instanceMethodName Ссылка на метод экземпляра произвольного an object определенного типа: SomeType::methodName Ссылка на конструктор: SomeClass::new Давайте взглянем на небольшой пример того, How методы могут быть использованы в качестве аргументов других методов. 01 public class MethodReference { 02 public static void println( String s ) { 03 System.out.println( s ); 04 } 05 06 public static void main( String[] args ) { 07 final Collection< String > strings = Arrays.asList( "s1", "s2", "s3" ); 08 strings.stream().forEach( MethodReference::println ); 09 } 10 } В последней строке main метод использует ссылку на println метод чтобы напечатать каждый элемент из коллекции строк в консоль, он передается в качестве аргумента другому методу, forEach.
9. Неизменность
Неизменность обращает на себя много внимания в эти дни, и Java не является исключением. Хорошо известно, что неизменности трудно добиться в Java, но это не значит, что это должно быть проигнорировано. В Java, неизменность - это все знания об изменении внутреннего состояния. В качестве примера, давайте взглянем на спецификации JavaBeans (http://docs.oracle.com/javase/tutorial/javabeans/). В ней говорится, очень ясно, что сеттеры могут изменить состояние an object, что- то до этого содержащего, и это то, что ожидает каждый разработчик Java. Тем не менее, альтернативный подход мог бы не менять состояние, а возвращать новый an object (new) каждый раз. Это не так страшно, How кажется, и новый Java 8 Date/Time API ( разработан под JSR 310: Date and Time API прикрытием) является отличным примером этого. Давайте взглянем на следующий фрагмент codeа: 1 final LocalDateTime now = LocalDateTime.now(); 2 final LocalDateTime tomorrow = now.plusHours( 24 ); 3 4 final LocalDateTime midnight = now 5 .withHour( 0 ) 6 .withMinute( 0 ) 7 .withSecond( 0 ) 8 .withNano( 0 ); Каждый вызов LocalDateTime an object, который должен изменить свое состояние возвращает новый экземпляр LocalDateTime, и держит оригинал без изменений. Это большой сдвиг в парадигме дизайна API по сравнению с старыми Calendar и Date, (которые, мягко говоря, были не очень приятны в использовании и вызвали много головной боли).
10. Документирование метода
В Java, в частности, если вы разрабатываете Howую-то библиотеку or framework, все публичные методы должны быть заdocumentированы с помощью инструмента Javadoc (http://www.oracle.com/technetwork/articles/java/index-jsp-135444.html). Строго говоря, ничего не заставляет вас делать это, но хорошая documentация помогает другим разработчикам понять, что конкретный метод делает, Howие аргументы он требует, Howовы предположения or ограничения его реализации, Howие типы исключений он вызывает и когда они возникают, Howое может быть возвращаемое meaning (если таковые имеются), а также многие другие вещи. Давайте взглянем на следующий пример: 01 /** 02 * The method parses the string argument as a signed decimal integer. 03 * The characters in the string must all be decimal digits, except 04 * that the first character may be a minus sign {@code '-'} or plus 05 * sign {@code '+'}. 06 * 07 *

An exception of type {@code NumberFormatException} is thrown if 08 * string is {@code null} or has length of zero. 09 * 10 *

Examples: 11 *

12	 * parse( "0" ) returns 0
13	 * parse( "+42") returns 42
14	 * parse( "-2" ) returns -2
15	 * parse( "string" ) throws a NumberFormatException
16	 * 
17 * 18 * @param str a {@code String} containing the {@code int} representation to be parsed 19 * @return the integer value represented by the string 20 * @exception NumberFormatException if the string does not contain a valid integer value 21 */ 22 public int parse( String str ) throws NumberFormatException { 23 return Integer.parseInt( str ); 24 }
Это довольно многословная documentация для такого простого метода How parse, но это показывает пару полезных возможностей обеспечиваемых инструментом Javadoc tool, в том числе ссылки на другие классы, образцы фрагментов и продвинутого форматирования. Вот How этот documentация методов отражается в Eclipse, одной из популярных Java IDE. Просто глядя на изображение выше, любой разработчик Java от младшего до старшего уровня может понять цель метода и надлежащим образом использовать ее.
11. Параметры метода и возвращаемые значения
Документирование ваших методов - это великая вещь, но, к сожалению, это не предупреждает случаи, когда метод называют, используя неправильные or неожиданные значения аргументов. Из-за этого, How правило, все публичные методы должны подтвердить свои аргументы и никогда не должны быть уверены, что все время при вызове будут указаны правильные значения (паттерн более известный How sanity checks (санитарная проверка)). Возвращаясь к нашему примеру из предыдущего раздела, метод parse должен выполнить проверку своего единственного аргумента, прежде чем делать что-нибудь с ним: 1 public int parse( String str ) throws NumberFormatException { 2 if( str == null ) { 3 throw new IllegalArgumentException( "String should not be null" ); 4 } 5 6 return Integer.parseInt( str ); 7 } Java имеет другой вариант выполнения проверки и sanity checks, используя assert операторы. Однако, те, которые могли быть выключены во время выполнения и могут быть не выполнены. Предпочтительно, всегда выполнять такие проверки и вызывать соответствующие исключения. Даже имея documentированные методы и проверку их аргументов, хочу сделать еще пару замечаний связанных с возвращаемыми значениями. До того How вышла Java 8, самым простым способом сказать что метод в данное время не имеет значения чтобы его возвратить было просто вернуть нуль. Вот почему Java так плохо получить исключение NullPointerException. Java 8 пытается решить этот вопрос с введением Optional < T > class. Давайте взглянем на этот пример: 1 public< T > Optional< T > find( String id ) { 2 // Some implementation here 3 } Optional < T > предоставляет много полезных методов, и fully устраняет необходимость возвращать в методе null и загрязнять везде ваш code проверками на null. Единственное исключение, вероятно, это коллекции. Всякий раз, когда метод возвращает коллекцию, всегда лучше вернуть null instead of null (и даже Optional < T >), например: 1 public< T > Collection< T > find( String id ) { 2 return Collections.emptyList(); 3 }
12. Метод How точка входа в приложение
Bahkan jika Anda seorang pengembang sederhana yang menulis aplikasi di organisasi Anda atau kontributor salah satu kerangka kerja atau perpustakaan Java yang paling populer, keputusan desain yang Anda buat memainkan peran yang sangat penting dalam bagaimana kode Anda akan digunakan. Walaupun pedoman desain API layak untuk dibaca dalam beberapa buku, bagian tutorial ini mencakup banyak diantaranya (bagaimana metode menjadi titik masuk ke API), sehingga gambaran singkat akan sangat membantu: • Gunakan nama yang bermakna untuk metode dan argumennya (Metode tanda tangan ) Usahakan jumlah argumen kurang dari 6 (bagian Tanda tangan metode) • Buat metode Anda singkat dan mudah dibaca (Bagian isi metode dan Sebaris) • Selalu dokumentasikan metode umum, termasuk prasyarat dan contoh jika masuk akal (bagian Metode Dokumentasi) • Selalu melakukan pemeriksaan argumen dan pemeriksaan kewarasan (bagian Parameter Metode dan Nilai Pengembalian) • Cobalah untuk menghindari null sebagai nilai pengembalian (bagian Parameter Metode dan Nilai Pengembalian) • Kapan pun masuk akal, cobalah merancang metode yang tidak dapat diubah (yang dapat tidak mempengaruhi keadaan internal, bagian Kekekalan) • Gunakan aturan visibilitas dan aksesibilitas untuk menyembunyikan metode yang tidak boleh dipublikasikan (bagian 3 dari tutorial, Cara mendesain Kelas dan Antarmuka)
13. Apa selanjutnya
Bagian tutorial ini tidak banyak membahas tentang Java sebagai sebuah bahasa, dan lebih banyak lagi tentang cara menggunakan bahasa Java secara efektif, khususnya menulis metode yang mudah dibaca, bersih, terdokumentasi, dan efisien. Di bagian selanjutnya, kita akan melanjutkan ide dasar yang sama dan mendiskusikan prinsip-prinsip pemrograman umum yang dirancang untuk membantu Anda menjadi pengembang Java yang lebih baik.
14. Unduh kode sumber
Pelajaran ini tentang bagaimana menulis metode secara efektif. Anda dapat mengunduh kode sumbernya di sini:
Komentar
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION