Основы грамотности Java на конкретных примерах. Часть I

Всем привет, сегодня я разберу исходник из темы "Исправление исходников" и, кроме непосредственно исправления, постараюсь дать исчерпывающие комментарии почему я делаю эти исправления именно так. Кроме того, я приведу в качестве решения свою версию кода. Итак, изначальный исходник (настоятельно рекомендую ознакомиться, чтобы быть в теме):

Открыть спойлер

Закрыть спойлер

[копировать] [скачать]

1. import javax.microedition.lcdui.*;
2.  
3. public class App extends Canvas implements Runnable{
4.  
5. public Font font;
6. public String str;
7. public String[] p;
8. public Parsing parsing;
9. int height;
10. int width;
11. int id;
12. int fh;
13.  
14. Boolean up;
15. Boolean down;
16.  
17.  
18. public App(String s){
19.  
20. super();
21.  
22. str = s;
23.  
24. setFullScreenMode(false);
25.  
26. parsing = new Parsing();
27.  
28. p = parsing.splitString(str,"\n");
29.  
30. Thread thread = new Thread(this);
31.  
32. font = Font.getFont(0,0,Font.SIZE_SMALL);
33.  
34. fh = font.getHeight();
35.  
36. height = getHeight();
37. width = getWidth();
38.  
39. id = 0;
40.  
41. up = false;
42. down = false;
43.  
44. thread.start();
45. }
46.  
47.  
48. public void run(){
49.  
50. while(true){
51.  
52.  
53. if (up == true) up();
54. if (down == true) down();
55.  
56. if (down == false) down = false;
57. if (up == false) up = false;
58.  
59. try{
60.  
61. Thread.sleep(20);
62.  
63. } catch (Exception e){}
64.  
65. }
66.  
67. }
68.  
69.  
70. public void paint(Graphics g){
71. g.setFont(Font.getFont(0,0,Font.SIZE_SMALL));
72. g.setColor(255,255,255);
73. g.fillRect(0,0,width,height);
74.  
75. for (int i=0; i< p.length; i++){
76.  
77. String in = Integer.toString(i);
78.  
79. g.setColor(0,0,0);
80. g.drawString(in + " "+p[i], 0, id + i* fh,20);
81.  
82. }
83. repaint();
84. }
85.  
86. public void keyPressed(int key){
87.  
88. if (key == Canvas.KEY_NUM2) up= true;
89.  
90. if (key == Canvas.KEY_NUM8) down = true;
91.  
92. }
93.  
94. public void keyRealised(int key){
95.  
96. if (key == Canvas.KEY_NUM2) up = false;
97.  
98. if (key == Canvas.KEY_NUM8) down = false;
99.  
100. }
101.  
102.  
103. public void down(){
104.  
105. if (fh * p.length> height){
106.  
107. id = id - fh;
108.  
109. if (height - id> p.length* fh) id = height - p.length* fh;
110.  
111.  
112. }
113. }
114.  
115. public void up(){
116.  
117. if (p.length* fh> height){
118.  
119. id = id + fh;
120.  
121. if (id > 0) id = 0;
122.  
123.    }
124. }
125.  
126. /* end */
127. }

Начинаем исправлять, двигаясь сверху вниз.

1. Бессмысленно использовать в данном конкретном случае полновесный объект Boolean, можно обойтись примитивным типом boolean, к тому же это позволит немного сэкономить память. Поэтому исправляем:
Также, переменная str не несет никакой полезной нагрузки, поэтому от нее можно избавиться.

2. Конструктор. При наследовании от Canvas не требуется специально вызывать конструктор суперкласса, поэтому смело можно удалять super() из конструктора. Также, как вы помните, мы избавились от переменной str, нужно вычистить ее из конструктора. Удалим строку str = s; , а строку p = parsing.splitString(str,"\n"); заменим на p = parsing.splitString(s,"\n");

3. Строка Thread thread = new Thread(this); избыточна, хотя и возможна. Однако красивее объединить ее с thread.start(); в конструкцию
чтобы не создавать лишних явных локальных объектов в конструкторе.

4. Метод run(). Строки
являются полной тавтологией, которую нужно удалить. Вообще, сравнение в стиле if (ololo == true) всегда лучше сократить до if (ololo). Кроме того, задержка в 5 мс вместо 20 вполне достаточна, а в catch следует указать точный вид возможного исключения - InterruptedException. В итоге метод стал выглядеть так:

5. Переходим в метод paint(Graphics g). Первое, что бросается в глаза - строка g.setFont(Font.getFont(0, 0, Font.SIZE_SMALL)); ведь у нас уже есть заранее заготовленный в конструкторе объект font. Поэтому заменяем параметр на него:
Далее следует цикл
займемся его оптимизацией.
Первое, что приходит в голову - вынести объявление переменной in за цикл. Однако, от него можно и вообще избавиться, об этом чуть ниже.
Второе, так как в процессе вывода строк их цвет не меняется динамически, то g.setColor(0,0,0); также можно вынести за пределы цикла.
третье, так как строки выводятся в цикле, то лучше заменить банальное сложение на конкатенацию, кроме того, последний параметр (якорь) не нужен, так как все координаты задаются явно, а так же избавимся от ненужной локальной переменной, то есть приводим строку
к виду

Итоговый вид метода:

6. Метод keyPressed(int key). Константы вида Canvas.KEY_NUM2 избыточны, так как наш класс уже является наследником Canvas, поэтому имя суперкласса можно опустить:
к тому же в таком варианте возможна ситуация, когда будут зажаты одновременно и 2 и 8, и текст просто застынет. Чтобы это исключить, следует использовать конструкцию switch вместо условий:
операторы break автоматически не дают выполнится неверным условиям.

7. keyRealised такого метода в Canvas нет вообще, есть keyReleased. Имеет смысл сделать его по аналогии с предыдущим методом, то есть:

8. Метод down() также можно немного оптимизировать. В первую очередь мы видим, что довольно часто используется конструкция fh * p.length. Можно рассчитать это значение вначале метода, также для красоты кода можно заменить строчку id = id - fh; на id -= fh; :

9. Метод up() в целом нормальный, но также можно заменить строку id = id + fh; на id += fh;

10. Комментарий /* end */ банален, его можно удалить.

Итого, получаем следующий код:

Открыть спойлер

Закрыть спойлер

[копировать] [скачать]

1. import javax.microedition.lcdui.*;
2.  
3. public class App extends Canvas implements Runnable{
4.  
5. public Font font;
6. public String[] p;
7. public Parsing parsing;
8. int height;
9. int width;
10. int id;
11. int fh;
12.  
13. boolean up;
14. boolean down;
15.  
16.  
17. public App(String s){
18.  
19. setFullScreenMode(false);
20.  
21. parsing = new Parsing();
22.  
23. p = parsing.splitString(s,"\n");
24.  
25. font = Font.getFont(0,0,Font.SIZE_SMALL);
26.  
27. fh = font.getHeight();
28.  
29. height = getHeight();
30. width = getWidth();
31.  
32. id = 0;
33.  
34. up = false;
35. down = false;
36.  
37. new Thread(this).start();
38. }
39.  
40.  
41. public void run(){
42.  
43. while(true){
44.  
45.  
46. if (up) up();
47. if (down) down();
48.  
49. try{
50.  
51. Thread.sleep(1);
52.  
53. } catch (InterruptedException e){}
54.  
55. }
56.  
57. }
58.  
59.  
60. public void paint(Graphics g){
61. g.setFont(font);
62. g.setColor(255,255,255);
63. g.fillRect(0,0,width,height);
64. g.setColor(0,0,0);
65.  
66. for (int i=0; i< p.length; i++) g.drawString(Integer.toString(i).concat(" ").concat(p[i]), 0, id + i * fh, 0);
67.  
68. repaint();
69. }
70.  
71. public void keyPressed(int key){
72.  
73. switch (key) {
74. case KEY_NUM2:
75.   up = true;
76.   break;
77. case KEY_NUM8:
78.   down = true;
79.   break;
80. }
81.  
82. }
83.  
84. public void keyReleased(int key){
85.  
86. switch (key) {
87. case KEY_NUM2:
88.   up = false;
89.   break;
90. case KEY_NUM8:
91.   down = false;
92.   break;
93. }
94.  
95. }
96.  
97.  
98. public void down(){
99. int tmp_height = fh * p.length;
100.  
101. if (tmp_height> height){
102.  
103. id -= fh;
104.  
105. if (height - id> tmp_height) id = height - tmp_height;
106.  
107.  
108. }
109. }
110.  
111. public void up(){
112.  
113. if (p.length* fh> height){
114.  
115. id += fh;
116.  
117. if (id > 0) id = 0;
118.  
119.    }
120. }
121.  
122. }

Теперь поговорим об оформлении кода. Понятно, что у каждого свои предпочтения и возможности для редактирования исходника, но лично я в свое время писал и на телефоне, и в блокноте, и, в итоге в NetBeans. При написании исходников на телефоне я придерживался определенных правил форматирования - никогда не ставил больше одного переноса подряд, отделял вложенные операторы двумя пробелами вместо табуляции, перед фигурной скобкой ставил пробел. Уже этого достаточно для оформления достаточно красивого, но читабельного на телефоне кода. Смотрим:

Открыть спойлер

Закрыть спойлер

[копировать] [скачать]

1. import javax.microedition.lcdui.*;
2.  
3. public class App extends Canvas implements Runnable {
4.  
5.   public Font font;
6.   public String[] p;
7.   public Parsing parsing;
8.   int height;
9.   int width;
10.   int id;
11.   int fh;
12.  
13.   boolean up;
14.   boolean down;
15.  
16.   public App(String s) {
17.     setFullScreenMode(false);
18.  
19.     parsing = new Parsing();
20.  
21.     p = parsing.splitString(s,"\n");
22.  
23.     font = Font.getFont(0,0,Font.SIZE_SMALL);
24.  
25.     fh = font.getHeight();
26.  
27.     height = getHeight();
28.     width = getWidth();
29.  
30.     id = 0;
31.  
32.     up = false;
33.     down = false;
34.  
35.     new Thread(this).start();
36.   }
37.  
38.  
39.   public void run() {
40.     while(true){
41.       if (up) up();
42.       if (down) down();
43.  
44.       try {
45.         Thread.sleep(5);
46.       } catch (InterruptedException e){}
47.     }
48.   }
49.  
50.  
51.   public void paint(Graphics g) {
52.     g.setFont(font);
53.     g.setColor(255,255,255);
54.     g.fillRect(0,0,width,height);
55.     g.setColor(0,0,0);
56.  
57.     for (int i=0; i< p.length; i++) g.drawString(Integer.toString(i).concat(" ").concat(p[i]), 0, id + i * fh, 0);
58.  
59.     repaint();
60.   }
61.  
62.   public void keyPressed(int key) {
63.     switch (key) {
64.       case KEY_NUM2:
65.         up = true;
66.         break;
67.       case KEY_NUM8:
68.         down = true;
69.         break;
70.     }
71.   }
72.  
73.   public void keyReleased(int key) {
74.     switch (key) {
75.       case KEY_NUM2:
76.         up = false;
77.         break;
78.       case KEY_NUM8:
79.         down = false;
80.         break;
81.     }
82.   }
83.  
84.   public void down() {
85.     int tmp_height = fh * p.length;
86.  
87.     if (tmp_height > height) {
88.       id -= fh;
89.  
90.       if (height - id> tmp_height) id = height - tmp_height;
91.     }
92.   }
93.  
94.   public void up() {
95.     if (p.length* fh > height) {
96.       id += fh;
97.  
98.       if (id > 0) id = 0;
99.     }
100.   }
101.  
102. }

Итак, основную идею я показал, в продолжении мы поговорим о логике программы и некоторых трюках, обеспечивающих с одной стороны эффективность, а с другой - красоту кода.