JavaRush /จาวาบล็อก /Random-TH /วิธีเขียนวิธีการอย่างมีประสิทธิภาพ (แปลบทความ)
pena
ระดับ
Москва

วิธีเขียนวิธีการอย่างมีประสิทธิภาพ (แปลบทความ)

เผยแพร่ในกลุ่ม
บทความต้นฉบับอยู่ที่: http://www.javacodegeeks.com/2015/09/how-to-write-methods-efficiently.html#download Tutorial เผยแพร่โดย: Andrey Redko (Andrey Redko) ใน Core Java (Java Core) 18 กันยายน 2558 หมายเหตุนี้เป็นส่วนหนึ่งของหลักสูตร Advanced Java ของสถาบันการศึกษาของเรา หลักสูตรนี้ออกแบบมาเพื่อช่วยให้คุณใช้ Java ได้อย่างมีประสิทธิภาพมากขึ้น จะมีการพูดคุยถึงหัวข้อขั้นสูงเพิ่มเติมที่นี่ เช่น การสร้างออบเจ็กต์ การทำให้ขนานกัน การทำให้เป็นอนุกรม การสะท้อนกลับ และอื่นๆ อีกมากมาย ความรู้นี้จะนำทางการเดินทางของคุณไปสู่จุดสูงสุดของความเชี่ยวชาญ Java
เนื้อหาหลักสูตร
1. บทนำ 2. ลายเซ็นของวิธีการ 3. เนื้อความของวิธีการ 4. วิธีการโอเวอร์โหลด 5. การเอาชนะวิธีการ 6. การฝังใน 7. การเรียกซ้ำ 8. การอ้างอิงวิธีการ 9. ความไม่เปลี่ยนรูป 10. เอกสารวิธีการ 11. พารามิเตอร์ของวิธีการและค่าที่ส่งคืน 12. วิธีการในฐานะ จุดเริ่มต้นไปยังภาคผนวก 13 อะไรต่อไป 14. การดาวน์โหลดซอร์สโค้ด
1. บทนำ
ในบทช่วยสอนในส่วนนี้ เราจะใช้เวลาอภิปรายแง่มุมต่างๆ ที่เกี่ยวข้องกับการออกแบบและวิธีการใช้งานใน Java ในส่วนก่อนหน้าของบทช่วยสอน คุณจะเห็นว่าวิธีการเขียนใน Java นั้นง่ายมาก แต่มีหลายสิ่งที่สามารถทำให้วิธีการของคุณอ่านง่ายขึ้นและมีประสิทธิภาพมากขึ้น
2. ลายเซ็นวิธีการ
ดังที่คุณทราบแล้วว่า Java เป็นภาษาเชิงวัตถุ โดยพื้นฐานแล้ว ทุกเมธอด Java เป็นของบางส่วนของคลาส (หรือของคลาสนั้นเองในกรณีของเมธอดทางสถิติ) มีกฎการมองเห็น (หรือการเข้าถึง) สามารถประกาศเป็นนามธรรมหรือขั้นสุดท้ายได้ และอื่นๆ อย่างไรก็ตาม บางทีส่วนที่สำคัญที่สุดของวิธีการก็คือลายเซ็นของมัน: ประเภทการส่งคืนและอาร์กิวเมนต์ รวมถึงรายการข้อยกเว้นที่ตรวจสอบแล้วของการดำเนินการแต่ละวิธีที่สามารถโยนทิ้งได้ (แต่ส่วนนี้ไม่ได้ใช้บ่อยในอดีต และแม้แต่น้อยในสมัยนี้ ). เริ่มจากตัวอย่างเล็กๆ น้อยๆ กันก่อน 1 public static void main( String[] args ) { 2 // Some implementation here 3 } วิธีการหลักใช้อาร์เรย์ของสตริงเป็นอาร์กิวเมนต์ args เท่านั้นและไม่ส่งคืนอะไรเลย คงจะดีมากถ้าทำให้วิธีการทั้งหมดเรียบง่ายเหมือนหลัก แต่ในความเป็นจริงแล้ว ลายเซ็นวิธีการอาจไม่สามารถอ่านได้ ลองดูตัวอย่างต่อไปนี้: 1 public void setTitleVisible( int lenght, String title, boolean visible ) { 2 // Some implementation here 3 } สิ่งแรกที่คุณสังเกตเห็นที่นี่คือแบบแผนถูกใช้โดยธรรมชาติในชื่อเมธอด Java เช่น setTitleVisible ชื่อนี้ถูกเลือกมาอย่างดีและพยายามอธิบายว่าเมธอดนี้ควรทำอย่างไร ประการที่สอง ชื่อของข้อโต้แย้งบอก (หรืออย่างน้อยก็บอกเป็นนัย) ว่าจุดประสงค์ของมันคืออะไร เป็นสิ่งสำคัญมากในการค้นหาชื่อที่ถูกต้องและมีความหมายสำหรับอาร์กิวเมนต์ของเมธอด แทนที่จะเป็น int i, String s, boolean f (อย่างไรก็ตาม ในบางกรณีที่เกิดขึ้นน้อยมาก สิ่งนี้ก็สมเหตุสมผล) ประการที่สาม วิธีการนี้มีเพียงสามข้อโต้แย้งเท่านั้น แม้ว่า Java จะมีขีดจำกัดที่สูงกว่ามากเกี่ยวกับจำนวนอาร์กิวเมนต์ที่อนุญาต ขอแนะนำอย่างยิ่งว่าอย่าให้เกินจำนวนอาร์กิวเมนต์ที่มากกว่า 6 การเกินขีดจำกัดนี้จะทำให้ลายเซ็นเข้าใจยาก ตั้งแต่ Java 5 เปิดตัว วิธีการสามารถมีรายการอาร์กิวเมนต์ประเภทเดียวกันที่แตกต่างกัน (เรียกว่า varargs) และใช้ไวยากรณ์พิเศษ ตัวอย่างเช่น 1 public void find( String … elements ) { 2 // Some implementation here 3 } ภายใน คอมไพเลอร์ Java แปลงอาร์กิวเมนต์ของตัวแปรเป็นอาร์เรย์ประเภทที่เหมาะสม ดังนั้นอาร์กิวเมนต์ของตัวแปรจึงสามารถ นำมาใช้เพื่อนำวิธีการไปใช้ สิ่งที่น่าสนใจคือ Java ยังให้คุณประกาศ varargs โดยใช้พารามิเตอร์ทั่วไปได้ อย่างไรก็ตาม เนื่องจากไม่ทราบประเภทของอาร์กิวเมนต์ คอมไพลเลอร์ Java ต้องการให้แน่ใจว่ามีการใช้ varargs อย่างถูกต้อง และแนะนำวิธีสุดท้ายที่จะใส่คำอธิบายประกอบด้วย @SafeVarargs (สำหรับข้อมูลเพิ่มเติม โปรดดูส่วนที่ 5 ของบทช่วยสอน วิธีการและเวลาที่ต้องใช้ การแจงนับและคำอธิบายประกอบ) เราใช้การแจงนับและความคิดเห็น) ตัวอย่างเช่น: 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 точка входа в приложение
แม้ว่าคุณจะเป็นนักพัฒนาทั่วไปที่เขียนแอปพลิเคชันในองค์กรของคุณหรือเป็นผู้มีส่วนร่วมในเฟรมเวิร์กหรือไลบรารี Java ที่ได้รับความนิยมมากที่สุดตัวใดตัวหนึ่ง การตัดสินใจในการออกแบบของคุณมีบทบาทสำคัญในวิธีการใช้โค้ดของคุณ แม้ว่าแนวทางการออกแบบ API จะคุ้มค่ากับหนังสือหลายเล่ม แต่บทช่วยสอนในส่วนนี้จะครอบคลุมหลายเล่ม (วิธีที่วิธีการต่างๆ กลายเป็นจุดเริ่มต้นของ API) ดังนั้นภาพรวมโดยย่อจะมีประโยชน์มาก: • ใช้ชื่อที่มีความหมายสำหรับวิธีการและข้อโต้แย้ง (วิธีการ) ลายเซ็น ) พยายามรักษาจำนวนอาร์กิวเมนต์ให้น้อยกว่า 6 (ส่วนลายเซ็นวิธีการ) • ทำให้วิธีการของคุณสั้นและอ่านง่าย (เนื้อหาวิธีการและส่วนอินไลน์) • บันทึกวิธีการสาธารณะเสมอ รวมถึงเงื่อนไขเบื้องต้นและตัวอย่างหากสมเหตุสมผล (ส่วนวิธีการ Documentation) • ดำเนินการตรวจสอบอาร์กิวเมนต์และการตรวจสอบสติอยู่เสมอ (ส่วน Method Parallel และ Return Values) • พยายามหลีกเลี่ยง null เป็นค่าที่ส่งคืน (ส่วน Method Parameters และ Return Values) • เมื่อใดก็ตามที่เหมาะสม พยายามออกแบบวิธีการที่ไม่เปลี่ยนรูป (ซึ่งทำ ไม่ส่งผลกระทบต่อสถานะภายใน ส่วนความไม่เปลี่ยนรูป) • ใช้กฎการมองเห็นและการเข้าถึงเพื่อซ่อนวิธีการที่ไม่ควรเปิดเผยต่อสาธารณะ (ส่วนที่ 3 ของบทช่วยสอน วิธีการออกแบบคลาสและอินเทอร์เฟซ)
13. อะไรต่อไป
บทช่วยสอนในส่วนนี้จะพูดถึง Java ในฐานะภาษาเพียงเล็กน้อย และเพิ่มเติมเกี่ยวกับวิธีใช้ภาษา Java อย่างมีประสิทธิภาพ โดยเฉพาะอย่างยิ่งการเขียนวิธีที่อ่านง่าย สะอาด มีเอกสาร และมีประสิทธิภาพ ในส่วนถัดไป เราจะใช้แนวคิดพื้นฐานเดียวกันต่อไป และอภิปรายหลักการเขียนโปรแกรมทั่วไปที่ได้รับการออกแบบมาเพื่อช่วยให้คุณเป็น Java Developer ที่ดีขึ้น
14. ดาวน์โหลดซอร์สโค้ด
บทเรียนนี้เป็นเกี่ยวกับวิธีการเขียนวิธีการอย่างมีประสิทธิภาพ คุณสามารถดาวน์โหลดซอร์สโค้ดได้ที่นี่:
ความคิดเห็น
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION