JavaRush /Blog Java /Random-VI /Cách viết phương pháp hiệu quả (bản dịch bài viết)
pena
Mức độ
Москва

Cách viết phương pháp hiệu quả (bản dịch bài viết)

Xuất bản trong nhóm
Bài viết gốc có tại: http://www.javacodegeeks.com/2015/09/how-to-write-methods-performancely.html#download hướng dẫn Được xuất bản bởi: Andrey Redko (Andrey Redko) trong Core Java (Java Core) Ngày 18 tháng 9 năm 2015 Ghi chú này là một phần trong khóa học Java nâng cao của học viện chúng tôi. Khóa học này được thiết kế để giúp bạn sử dụng Java hiệu quả hơn. Các chủ đề nâng cao hơn sẽ được thảo luận ở đây, chẳng hạn như tạo đối tượng, song song hóa, tuần tự hóa, phản ánh, v.v. Kiến thức này sẽ hướng dẫn hành trình của bạn đạt đến đỉnh cao thành thạo Java.
Những nội dung khóa học
1. Giới thiệu 2. Chữ ký phương thức 3. Thân phương thức 4. Nạp chồng phương thức 5. Ghi đè phương thức 6. Nội tuyến 7. Đệ quy 8. Tham chiếu phương thức 9. Tính bất biến 10. Tài liệu phương thức 11. Tham số phương thức và giá trị trả về 12. Phương thức như một điểm vào Phụ lục 13. Tiếp theo là gì 14. Tải mã nguồn
1. Giới thiệu
Trong phần hướng dẫn này, chúng ta sẽ dành chút thời gian thảo luận về các khía cạnh khác nhau liên quan đến việc thiết kế và triển khai các phương thức trong Java. Trong phần trước của hướng dẫn, bạn có thể thấy rằng các phương thức viết trong Java rất đơn giản, nhưng có nhiều thứ có thể làm cho các phương thức của bạn dễ đọc và hiệu quả hơn.
2. Chữ ký phương thức
Như các bạn đã biết, Java là ngôn ngữ hướng đối tượng. Về cơ bản, mọi phương thức Java đều thuộc về một phần nào đó của một lớp (hoặc thuộc về chính lớp đó trong trường hợp phương thức thống kê). Nó có các quy tắc về khả năng hiển thị (hoặc khả năng truy cập), có thể được khai báo là trừu tượng hoặc cuối cùng, v.v. Tuy nhiên, có lẽ phần quan trọng nhất của một phương thức là chữ ký của nó: kiểu trả về và các đối số, cùng với danh sách các ngoại lệ được kiểm tra trong quá trình triển khai của mỗi phương thức có thể được đưa ra (nhưng phần này trước đây không được sử dụng thường xuyên và thậm chí ngày nay thậm chí còn ít được sử dụng hơn). ). Hãy bắt đầu với một ví dụ nhỏ. 1 public static void main( String[] args ) { 2 // Some implementation here 3 } Phương thức main chỉ lấy một mảng các chuỗi làm đối số args và không trả về gì cả. Sẽ rất tuyệt nếu làm cho tất cả các phương thức đơn giản như main. Nhưng trong thực tế, chữ ký phương thức có thể không đọc được. Hãy xem ví dụ sau: 1 public void setTitleVisible( int lenght, String title, boolean visible ) { 2 // Some implementation here 3 } Điều đầu tiên bạn nhận thấy ở đây là các quy ước được sử dụng nguyên gốc trong các tên phương thức Java, chẳng hạn như setTitleVisible. Tên này được chọn tốt và cố gắng mô tả những gì phương thức đó phải làm. Thứ hai, tên của các lập luận cho biết (hoặc ít nhất là gợi ý) mục đích của chúng là gì. Điều rất quan trọng là phải tìm đúng tên, có ý nghĩa cho các đối số của phương thức, thay vì int i, String s, boolean f (tuy nhiên, trong những trường hợp rất hiếm, điều này lại có ý nghĩa). Thứ ba, phương thức chỉ có ba đối số. Mặc dù Java có giới hạn cao hơn nhiều về số lượng đối số được phép, nhưng chúng tôi khuyên bạn không nên vượt quá số lượng đối số lớn hơn 6. Việc vượt quá giới hạn này sẽ khiến chữ ký khó hiểu. Kể từ khi Java 5 được phát hành, các phương thức có thể có các danh sách đối số cùng loại khác nhau (được gọi là varargs) và sử dụng cú pháp đặc biệt, ví dụ: 1 public void find( String … elements ) { 2 // Some implementation here 3 } Bên trong, trình biên dịch Java chuyển đổi các đối số biến thành một mảng gồm các kiểu thích hợp và do đó các đối số biến có thể được được áp dụng để thực hiện phương pháp này. Điều thú vị là Java cũng cho phép bạn khai báo các biến thể bằng các tham số chung. Tuy nhiên, vì loại đối số không xác định nên trình biên dịch Java muốn chắc chắn rằng các biến thể được sử dụng đúng cách và khuyên các phương thức cuối cùng nên được chú thích bằng @SafeVarargs (để biết thêm thông tin, hãy xem Phần 5 của hướng dẫn, Cách thức và thời điểm sử dụng Enums và Annotations. Chúng tôi sử dụng Enumerations và Comments) Ví dụ: 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 точка входа в приложение
Ngay cả khi bạn là một nhà phát triển đơn giản viết ứng dụng trong tổ chức của mình hoặc là người đóng góp cho một trong những khung hoặc thư viện Java phổ biến nhất, thì các quyết định thiết kế mà bạn đưa ra vẫn đóng một vai trò rất quan trọng trong cách sử dụng mã của bạn. Mặc dù các nguyên tắc thiết kế API đáng giá vài cuốn sách, nhưng phần hướng dẫn này bao gồm nhiều hướng dẫn trong số đó (cách các phương thức trở thành điểm truy cập vào một API), do đó, một cái nhìn tổng quan nhanh sẽ rất hữu ích: • Sử dụng các tên có ý nghĩa cho các phương thức và đối số của chúng (Phương thức signatures ) Cố gắng giữ số lượng đối số nhỏ hơn 6 (Phần chữ ký phương thức) • Giữ cho các phương thức của bạn ngắn gọn và dễ đọc (Phần nội dung và nội dung phương thức) • Luôn ghi lại các phương thức công khai, bao gồm các điều kiện tiên quyết và ví dụ nếu nó hợp lý (phần Phương thức Tài liệu) • Luôn thực hiện kiểm tra đối số và kiểm tra độ chính xác (phần Tham số phương thức và Giá trị trả về) • Cố gắng tránh null làm giá trị trả về (phần Tham số phương thức và Giá trị trả về) • Bất cứ khi nào thấy hợp lý, hãy thử thiết kế các phương thức bất biến (điều này làm không ảnh hưởng đến trạng thái bên trong, phần Bất biến) • Sử dụng các quy tắc hiển thị và khả năng truy cập để ẩn các phương thức không được công khai (phần 3 của hướng dẫn, Cách thiết kế Lớp và Giao diện)
13. Điều gì tiếp theo
Phần hướng dẫn này nói ít hơn một chút về Java như một ngôn ngữ mà nói nhiều hơn về cách sử dụng ngôn ngữ Java một cách hiệu quả, đặc biệt là cách viết các phương thức hiệu quả, rõ ràng, được ghi thành tài liệu và dễ đọc. Trong phần tiếp theo, chúng ta sẽ tiếp tục ý tưởng cơ bản tương tự và thảo luận về các nguyên tắc lập trình chung được thiết kế để giúp bạn trở thành nhà phát triển Java giỏi hơn.
14. Tải mã nguồn
Bài học này nói về cách viết các phương thức một cách hiệu quả. Bạn có thể tải mã nguồn tại đây:
Bình luận
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION