forked from piotrplenik/clean-code-php
-
Notifications
You must be signed in to change notification settings - Fork 43
/
README.md
2030 lines (1556 loc) · 53.5 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Clean Code PHP - 한글판
## 목차
1. [들어가며](#들어가며)
2. [변수](#변수)
* [의미있고 발음하기 쉬운 변수명을 사용하세요](#의미있고-발음하기-쉬운-변수명을-사용하세요)
* [같은 타입의 변수에는 동일한 어휘를 사용하세요](#같은-타입의-변수에는-동일한-어휘를-사용하세요)
* [찾기 쉬운 이름을 사용하세요 (part 1)](#찾기-쉬운-이름을-사용하세요-part-1)
* [찾기 쉬운 이름을 사용하세요 (part 2)](#찾기-쉬운-이름을-사용하세요-part-2)
* [설명적인 변수를 사용하세요](#설명적인-변수를-사용하세요)
* [너무 깊은 중첩은 피하고 초기에 return 하세요 (part 1)](#너무-깊은-중첩은-피하고-초기에-return-하세요-part-1)
* [너무 깊은 중첩은 피하고 초기에 return 하세요 (part 2)](#너무-깊은-중첩은-피하고-초기에-return-하세요-part-2)
* [머릿속으로 짐작하게 하지 마세요](#머릿속으로-짐작하게-하지-마세요)
* [불필요한 문맥을 덧붙이지 마세요](#불필요한-문맥을-덧붙이지-마세요)
* [단락이나 조건문 대신 기본 인수를 사용하세요](#단락이나-조건문-대신-기본-인수를-사용하세요)
3. [비교 연산자](#비교-연산자)
* [동일 비교 연산자를 사용하세요](#동일-비교-연산자를-사용하세요)
4. [함수](#함수)
* [함수 인수 (2개 이하가 이상적)](#함수-인수-2개-이하가-이상적)
* [함수는 한가지만 해야합니다](#함수는-한가지만-해야합니다)
* [함수명은 어떤 일을 하는지 나타내야 합니다](#함수명은-어떤-일을-하는지-나타내야-합니다)
* [함수는 추상화 레벨이 단 하나여야 합니다](#함수는-추상화-레벨이-단-하나여야-합니다)
* [플래그를 함수의 매개변수로 사용하지 마세요](#플래그를-함수의-매개변수로-사용하지-마세요)
* [부작용을 피하세요](#부작용을-피하세요)
* [전역 함수를 사용하지 마세요](#전역-함수를-사용하지-마세요)
* [싱글턴 패턴을 사용하지 마세요](#싱글턴-패턴을-사용하지-마세요)
* [조건문은 캡슐화하세요](#조건문은-캡슐화하세요)
* [부정 조건문을 피하세요](#부정-조건문을-피하세요)
* [조건문을 피하세요](#조건문을-피하세요)
* [타입 체킹을 피하세요 (part 1)](#타입-체킹을-피하세요-part-1)
* [타입 체킹을 피하세요 (part 2)](#타입-체킹을-피하세요-part-2)
* [불필요한 코드는 제거하세요](#불필요한-코드는-제거하세요)
5. [객체와 자료구조](#객체와-자료구조)
* [객체 캡슐화를 사용하세요](#객체-캡슐화를-사용하세요)
* [객체가 private/protected 멤버를 갖게 하세요](#객체가-privateprotected-멤버를-갖게-하세요)
6. [클래스](#클래스)
* [상속보다는 컴포지션을 사용하세요](#상속보다는-컴포지션을-사용하세요)
* [유창한 인터페이스를 피하세요](#유창한-인터페이스를-피하세요)
7. [SOLID](#solid)
* [단일 책임 원칙 (SRP)](#단일-책임-원칙-srp)
* [개방/폐쇄 원칙 (OCP)](#개방폐쇄-원칙-ocp)
* [리스코브 치환 원칙 (LSP)](#리스코브-치환-원칙-lsp)
* [인터페이스 분리 원칙 (ISP)](#인터페이스-분리-원칙-isp)
* [의존성 역전 원칙 (DIP)](#의존성-역전-원칙-dip)
8. [반복하지 마세요 (DRY)](#반복하지-마세요-dry)
9. [번역](#번역)
## 들어가며
Robert C. Martin의 책, 소프트웨어 엔지니어링의 교과서라고 불리는 [*Clean Code*](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882) PHP 버전입니다.
이 문서는 스타일 가이드가 아닙니다. PHP로 읽기 쉽고 재사용 가능하며, 리팩토링이 쉬운 소프트웨어를 만들어내기 위한 안내서입니다.
문서의 모든 원칙을 엄격하게 지켜야 할 필요는 없습니다. 그리고 어떤 것들은 일반적으로 합의되지 못할 것입니다.
이 문서는 안내서일 뿐이고 그 이상이 될 순 없지만, 수년간 *Clean Code*의 저자들로부터 축적된 경험을 문서화 한 것입니다.
[clean-code-javascript](https://github.com/ryanmcdermott/clean-code-javascript)에 영감을 받아 작성되었습니다.
여전히 PHP 5를 사용하는 개발자가 많겠지만, 문서의 예제 대부분은 PHP 7.1 이상의 버전에서만 작동합니다.
## 변수
### 의미있고 발음하기 쉬운 변수명을 사용하세요
**나쁜 예:**
```php
$ymdstr = $moment->format('y-m-d');
```
**좋은 예:**
```php
$currentDate = $moment->format('y-m-d');
```
**[⬆ 위로 가기](#목차)**
### 같은 타입의 변수에는 동일한 어휘를 사용하세요
**나쁜 예:**
```php
getUserInfo();
getUserData();
getUserRecord();
getUserProfile();
```
**좋은 예:**
```php
getUser();
```
**[⬆ 위로 가기](#목차)**
### 찾기 쉬운 이름을 사용하세요 (part 1)
작성해야 할 코드보다 읽어야 할 코드가 더 많습니다. 우리가 작성해야 할 코드를 읽기 쉽고 찾기 쉽게 만드는 것은 중요합니다.
프로그램을 이해하기 쉽도록 변수명을 의미 있게 짓지 *않는*다면, 코드를 읽는 사람을 곤란하게 만드는 것입니다.
변수명을 찾기 쉽게 만드세요.
**나쁜 예:**
```php
// 도대체 448이 뭔 뜻이래요?
$result = $serializer->serialize($data, 448);
```
**좋은 예:**
```php
$json = $serializer->serialize($data, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
```
### 찾기 쉬운 이름을 사용하세요 (part 2)
**나쁜 예:**
```php
// 4는 무슨 의미인가요?
if ($user->access & 4) {
// ...
}
```
**좋은 예:**
```php
class User
{
const ACCESS_READ = 1;
const ACCESS_CREATE = 2;
const ACCESS_UPDATE = 4;
const ACCESS_DELETE = 8;
}
if ($user->access & User::ACCESS_UPDATE) {
// 수정하세요...
}
```
**[⬆ 위로 가기](#목차)**
### 설명적인 변수를 사용하세요
**나쁜 예:**
```php
$address = 'One Infinite Loop, Cupertino 95014';
$cityZipCodeRegex = '/^[^,]+,\s*(.+?)\s*(\d{5})$/';
preg_match($cityZipCodeRegex, $address, $matches);
saveCityZipCode($matches[1], $matches[2]);
```
**나쁘진 않은 예:**
조금 낫군요. 하지만, 여전히 regex에 아주 많이 의존하고 있습니다.
```php
$address = 'One Infinite Loop, Cupertino 95014';
$cityZipCodeRegex = '/^[^,]+,\s*(.+?)\s*(\d{5})$/';
preg_match($cityZipCodeRegex, $address, $matches);
[, $city, $zipCode] = $matches;
saveCityZipCode($city, $zipCode);
```
**좋은 예:**
naming subpattern을 사용해서 regex의 의존성을 줄입시다.
```php
$address = 'One Infinite Loop, Cupertino 95014';
$cityZipCodeRegex = '/^[^,]+,\s*(?<city>.+?)\s*(?<zipCode>\d{5})$/';
preg_match($cityZipCodeRegex, $address, $matches);
saveCityZipCode($matches['city'], $matches['zipCode']);
```
**[⬆ 위로 가기](#목차)**
### 너무 깊은 중첩은 피하고 초기에 return 하세요 (part 1)
너무 많은 if else 문은 코드를 따라가기 어렵게 만들 수 있습니다. 명료한 것이 암시하는 것보다 나아요.
**나쁜 예:**
```php
function isShopOpen($day): bool
{
if ($day) {
if (is_string($day)) {
$day = strtolower($day);
if ($day === 'friday') {
return true;
} elseif ($day === 'saturday') {
return true;
} elseif ($day === 'sunday') {
return true;
} else {
return false;
}
} else {
return false;
}
} else {
return false;
}
}
```
**좋은 예:**
```php
function isShopOpen(string $day): bool
{
if (empty($day)) {
return false;
}
$openingDays = [
'friday', 'saturday', 'sunday'
];
return in_array(strtolower($day), $openingDays, true);
}
```
**[⬆ 위로 가기](#목차)**
### 너무 깊은 중첩은 피하고 초기에 return 하세요 (part 2)
**나쁜 예:**
```php
function fibonacci(int $n)
{
if ($n < 50) {
if ($n !== 0) {
if ($n !== 1) {
return fibonacci($n - 1) + fibonacci($n - 2);
} else {
return 1;
}
} else {
return 0;
}
} else {
return 'Not supported';
}
}
```
**좋은 예:**
```php
function fibonacci(int $n): int
{
if ($n === 0 || $n === 1) {
return $n;
}
if ($n > 50) {
throw new \Exception('Not supported');
}
return fibonacci($n - 1) + fibonacci($n - 2);
}
```
**[⬆ 위로 가기](#목차)**
### 머릿속으로 짐작하게 하지 마세요
우리의 코드를 읽는 사람이 변수가 어떤 의미인지 해석하게 하지 마세요.
명료한 것이 암시하는 것보다 좋아요.
**나쁜 예:**
```php
$l = ['Austin', 'New York', 'San Francisco'];
for ($i = 0; $i < count($l); $i++) {
$li = $l[$i];
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
// 잠깐 $li가 뭐였죠?
dispatch($li);
}
```
**좋은 예:**
```php
$locations = ['Austin', 'New York', 'San Francisco'];
foreach ($locations as $location) {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
dispatch($location);
}
```
**[⬆ 위로 가기](#목차)**
### 불필요한 문맥을 덧붙이지 마세요
클래스/객체 명이 이미 말해주고 있다면, 변수명에 굳이 번복하지 마세요.
**나쁜 예:**
```php
class Car
{
public $carMake;
public $carModel;
public $carColor;
//...
}
```
**좋은 예:**
```php
class Car
{
public $make;
public $model;
public $color;
//...
}
```
**[⬆ 위로 가기](#목차)**
### 단락이나 조건문 대신 기본 인수를 사용하세요
**좋진 않은 예:**
아래 예제는 `$breweryName`이 `NULL`이 될 수 있으므로 좋지 않아요.
```php
function createMicrobrewery($breweryName = 'Hipster Brew Co.'): void
{
// ...
}
```
**나쁘진 않은 예:**
위의 예제보다 훨씬 이해하기 쉬워졌습니다. 하지만 변수의 값을 제어하는 게 낫겠습니다.
```php
function createMicrobrewery($name = null): void
{
$breweryName = $name ?: 'Hipster Brew Co.';
// ...
}
```
**좋은 예:**
[type hinting](http://php.net/manual/en/functions.arguments.php#functions.arguments.type-declaration)을 사용해서 `$breweryName`이 `NULL`이 될 수 없음을 확신할 수 있습니다.
```php
function createMicrobrewery(string $breweryName = 'Hipster Brew Co.'): void
{
// ...
}
```
**[⬆ 위로 가기](#목차)**
## 비교 연산자
**[⬆ 위로 가기](#목차)**
### [동일 비교 연산자](http://php.net/manual/en/language.operators.comparison.php)를 사용하세요
**좋진 않은 예:**
```php
$a = '42';
$b = 42;
단순한 비교 연산자를 사용하면 string이 int로 변환 될 것입니다.
if( $a != $b ) {
//이 표현식은 항상 건너 뛸 것입니다.
}
```
$a != $b는 false를 리턴하지만 사실은 true가 맞아요!
string '42'는 int 42와 다릅니다.
**좋은 예:**
동일 비교 연산자를 사용하면 자료형과 값을 비교합니다.
```php
if( $a !== $b ) {
//이 표현식은 확인되었습니다.
}
```
$a !== $b는 true를 return 합니다.
**[⬆ 위로 가기](#목차)**
## 함수
### 함수 인수 (2개 이하가 이상적)
함수 매개변수의 개수를 제한하는 것은 엄청나게 중요합니다. 함수를 테스트하는 것을 더 쉽게 만들어 주기 때문이죠. 3개 이상의 매개변수는 테스트 조합을 폭발하게 합니다. 매개변수마다 서로 다른 수많은 케이스를 테스트해야 하기 때문입니다.
매개변수가 없는 것(0개)이 가장 이상적입니다. 1개에서 2개 정도는 괜찮습니다. 3개는 피해야 합니다. 매개변수가 3개를 넘어가면 통합되어야 합니다. 일반적으로, 매개변수가 2개 이상이라면 그 함수는 너무 많은 역할을 하는 것입니다. 그런 경우가 아니라면, 상위 레벨의 객체는 대부분 하나의 매개변수로 충분할 것입니다.
**나쁜 예:**
```php
function createMenu(string $title, string $body, string $buttonText, bool $cancellable): void
{
// ...
}
```
**좋은 예:**
```php
class MenuConfig
{
public $title;
public $body;
public $buttonText;
public $cancellable = false;
}
$config = new MenuConfig();
$config->title = 'Foo';
$config->body = 'Bar';
$config->buttonText = 'Baz';
$config->cancellable = true;
function createMenu(MenuConfig $config): void
{
// ...
}
```
**[⬆ 위로 가기](#목차)**
### 함수는 한가지만 해야합니다
소프트웨어 엔지니어링에서 가장 중요한 규칙입니다. 함수가 1개 이상의 역할을 하게 되면, 작성, 테스트, 추론하기가 어려워집니다. 함수를 단 하나의 행동으로 떼어낼 수 있다면, 코드는 쉽게 리팩토링 될 수 있으며 훨씬 더 깔끔하게 읽힐 것입니다. 이 문서에서 나머지는 다 갖다 버리고 이것만 지키신대도 웬만한 개발자보다 앞서게 될 것입니다.
**나쁜 예:**
```php
function emailClients(array $clients): void
{
foreach ($clients as $client) {
$clientRecord = $db->find($client);
if ($clientRecord->isActive()) {
email($client);
}
}
}
```
**좋은 예:**
```php
function emailClients(array $clients): void
{
$activeClients = activeClients($clients);
array_walk($activeClients, 'email');
}
function activeClients(array $clients): array
{
return array_filter($clients, 'isClientActive');
}
function isClientActive(int $client): bool
{
$clientRecord = $db->find($client);
return $clientRecord->isActive();
}
```
**[⬆ 위로 가기](#목차)**
### 함수명은 어떤 일을 하는지 나타내야 합니다.
**나쁜 예:**
```php
class Email
{
//...
public function handle(): void
{
mail($this->to, $this->subject, $this->body);
}
}
$message = new Email(...);
// 이게 뭘까요? 메세지를 위한 핸들? 지금 우리가 파일을 작성할건가요?
$message->handle();
```
**좋은 예:**
```php
class Email
{
//...
public function send(): void
{
mail($this->to, $this->subject, $this->body);
}
}
$message = new Email(...);
// 분명하고 명백하군요
$message->send();
```
**[⬆ 위로 가기](#목차)**
### 함수는 추상화 레벨이 단 하나여야 합니다
추상화 레벨이 하나 이상이라면, 보통 우리의 함수는 너무 많은 일을 하고 있는 것입니다. 함수를 분리하면 재사용성을 높일 수 있고 테스트가 용이해집니다.
**나쁜 예:**
```php
function parseBetterJSAlternative(string $code): void
{
$regexes = [
// ...
];
$statements = explode(' ', $code);
$tokens = [];
foreach ($regexes as $regex) {
foreach ($statements as $statement) {
// ...
}
}
$ast = [];
foreach ($tokens as $token) {
// lex...
}
foreach ($ast as $node) {
// parse...
}
}
```
**여전히 나쁜 예:**
기능의 일부를 옮겼지만, `parseBetterJSAlternative()` 함수는 여전히 너무 복잡하고 테스트할 수 없습니다.
```php
function tokenize(string $code): array
{
$regexes = [
// ...
];
$statements = explode(' ', $code);
$tokens = [];
foreach ($regexes as $regex) {
foreach ($statements as $statement) {
$tokens[] = /* ... */;
}
}
return $tokens;
}
function lexer(array $tokens): array
{
$ast = [];
foreach ($tokens as $token) {
$ast[] = /* ... */;
}
return $ast;
}
function parseBetterJSAlternative(string $code): void
{
$tokens = tokenize($code);
$ast = lexer($tokens);
foreach ($ast as $node) {
// parse...
}
}
```
**좋은 예:**
가장 좋은 해결책은 `parseBetterJSAlternative()` 함수의 의존성을 제거하는 것 입니다.
```php
class Tokenizer
{
public function tokenize(string $code): array
{
$regexes = [
// ...
];
$statements = explode(' ', $code);
$tokens = [];
foreach ($regexes as $regex) {
foreach ($statements as $statement) {
$tokens[] = /* ... */;
}
}
return $tokens;
}
}
class Lexer
{
public function lexify(array $tokens): array
{
$ast = [];
foreach ($tokens as $token) {
$ast[] = /* ... */;
}
return $ast;
}
}
class BetterJSAlternative
{
private $tokenizer;
private $lexer;
public function __construct(Tokenizer $tokenizer, Lexer $lexer)
{
$this->tokenizer = $tokenizer;
$this->lexer = $lexer;
}
public function parse(string $code): void
{
$tokens = $this->tokenizer->tokenize($code);
$ast = $this->lexer->lexify($tokens);
foreach ($ast as $node) {
// parse...
}
}
}
```
**[⬆ 위로 가기](#목차)**
### 플래그를 함수의 매개변수로 사용하지 마세요
플래그를 사용하는 것은 함수가 한가지 이상의 일을 할 것이라 말하는 셈입니다. 함수는 한 가지 일을 해야 합니다.
만약 Boolean 값에 따라 서로 다른 코드를 사용해야 한다면 함수를 분리하세요.
**나쁜 예:**
```php
function createFile(string $name, bool $temp = false): void
{
if ($temp) {
touch('./temp/'.$name);
} else {
touch($name);
}
}
```
**좋은 예:**
```php
function createFile(string $name): void
{
touch($name);
}
function createTempFile(string $name): void
{
touch('./temp/'.$name);
}
```
**[⬆ 위로 가기](#목차)**
### 부작용을 피하세요
함수는 다른 값을 가져와서 반환하는 것 외에 다른 기능을 수행하는 경우 부작용을 낳습니다.
부작용은 파일에 쓰는 것일 수도 있고, 몇몇 전역 변수의 값을 수정하는 것, 실수로 모든 돈을 낯선 사람에게 보내는 것이 될 수 있습니다.
때때로 프로그램에서 부작용을 가질 필요가 있습니다. 앞의 예와 같이, 한 파일에 쓸 필요가 있을 수 있습니다.
우리가 하고 싶은 것은 이 일을 하는 곳을 모으는 것입니다. 특정 파일에 쓰기 위한 여러 개의 함수와 클래스를 갖지 마세요.
그 역할을 하는 하나의 서비스만 가지세요. 하나, 단 하나만요.
요점은 일반적인 함정을 피하라는 것입니다. 구조가 없는 객체 간에 상태를 공유하는 것이나, 어떤 것으로도 쓰일 수 있는 변동성 데이터를 사용하는 것, 부작용이 발생할 수 있는 곳을 모으지 않는 것 같은 함정에서요.
만약 우리가 함정을 피할 수 있다면, 다른 대부분의 프로그래머보다 더 행복해질 거예요.
**나쁜 예:**
```php
// 다음 함수에서 참조하는 전역 변수
// 이 이름을 사용하는 다른 함수가 있다면, 이제 배열이 되었을거고 함수가 작동하지 않을 수 있습니다.
$name = 'Ryan McDermott';
function splitIntoFirstAndLastName(): void
{
global $name;
$name = explode(' ', $name);
}
splitIntoFirstAndLastName();
var_dump($name); // ['Ryan', 'McDermott'];
```
**좋은 예:**
```php
function splitIntoFirstAndLastName(string $name): array
{
return explode(' ', $name);
}
$name = 'Ryan McDermott';
$newName = splitIntoFirstAndLastName($name);
var_dump($name); // 'Ryan McDermott';
var_dump($newName); // ['Ryan', 'McDermott'];
```
**[⬆ 위로 가기](#목차)**
### 전역 함수를 사용하지 마세요
전역을 오염시키는 것은 여러 언어에서 나쁜 관행입니다. 왜냐하면 다른 라이브러리와 충돌 할 수 있고 API 사용자는 상용에서 예외를 받을 때까지 종잡을 수 없기 때문이죠.
예를 들어볼까요? 만약 설정 배열을 갖고싶다면 어떨까요? `config()`같은 전역 함수를 작성할 수 있지만, 같은 작업을 시도하려는 다른 라이브러리와 충돌 할 수 있습니다.
**나쁜 예:**
```php
function config(): array
{
return [
'foo' => 'bar',
]
}
```
**좋은 예:**
```php
class Configuration
{
private $configuration = [];
public function __construct(array $configuration)
{
$this->configuration = $configuration;
}
public function get(string $key): ?string
{
return isset($this->configuration[$key]) ? $this->configuration[$key] : null;
}
}
```
설정을 불러오고 `Configuration` 클래스의 인스턴스를 생성하세요.
```php
$configuration = new Configuration([
'foo' => 'bar',
]);
```
이제 우리는 애플리케이션에서 `Configuration`의 인스턴스를 반드시 사용해야 합니다.
**[⬆ 위로 가기](#목차)**
### 싱글턴 패턴을 사용하지 마세요
싱글턴은 [안티 패턴](https://en.wikipedia.org/wiki/Singleton_pattern) 입니다.
Brian Button이 쉽게 풀어쓴 바로는
1. 싱글턴은 일반적으로 **전역 인스턴스** 로 사용되는데, 왜 그게 그렇게 나쁠까요? 그 이유는 애플리케이션의 **의존성** 을 인터페이스를 통해 노출하는 대신 코드에 **숨기기** 때문입니다. 넘기는 것을 피하기 위해 무언가를 전역으로 만드는 것은 [코드 스멜](https://en.wikipedia.org/wiki/Code_smell)입니다.
2. **스스로의 생성과 생명주기를 제어** 한다는 사실에 의해서 [단일 책임 원칙](#단일-책임-원칙-srp)를 어깁니다.
3. 본질적으로 코드를 단단하게 [결합](https://en.wikipedia.org/wiki/Coupling_%28computer_programming%29)시키는 원인이 됩니다. 이로인해 많은 경우에서 **테스트가 어려워지게** 만듭니다.
4. 애플리케이션의 생명주기 동안 상태를 유지합니다. 유닛 테스트에서는 크게 문제가 되지 않지만 **테스트가 요구되는 상황으로 끝날 수 있어** 또 다른 타격이 발생할 수 있습니다. 그 이유는 무엇일까요? 각각의 유닛 테스트는 다른 유닛 테스트와 독립적이어야 하기 때문입니다.
[Misko Hevery](http://misko.hevery.com/about/)가 [문제의 근원](http://misko.hevery.com/2008/08/25/root-cause-of-singletons/)에 대해 작성한 매우 좋은 생각도 있습니다.
**나쁜 예:**
```php
class DBConnection
{
private static $instance;
private function __construct(string $dsn)
{
// ...
}
public static function getInstance(): DBConnection
{
if (self::$instance === null) {
self::$instance = new self();
}
return self::$instance;
}
// ...
}
$singleton = DBConnection::getInstance();
```
**좋은 예:**
```php
class DBConnection
{
public function __construct(string $dsn)
{
// ...
}
// ...
}
```
`DBConnection` 클래스의 인스턴스를 생성하고 [DSN](http://php.net/manual/en/pdo.construct.php#refsect1-pdo.construct-parameters)을 설정합니다.
```php
$connection = new DBConnection($dsn);
```
이제 우리는 어플리케이션에서 `DBConnection`의 인스턴스를 사용해야 합니다.
**[⬆ 위로 가기](#목차)**
### 조건문은 캡슐화하세요
**나쁜 예:**
```php
if ($article->state === 'published') {
// ...
}
```
**좋은 예:**
```php
if ($article->isPublished()) {
// ...
}
```
**[⬆ 위로 가기](#목차)**
### 부정 조건문을 피하세요
**나쁜 예:**
```php
function isDOMNodeNotPresent(\DOMNode $node): bool
{
// ...
}
if (!isDOMNodeNotPresent($node))
{
// ...
}
```
**좋은 예:**
```php
function isDOMNodePresent(\DOMNode $node): bool
{
// ...
}
if (isDOMNodePresent($node)) {
// ...
}
```
**[⬆ 위로 가기](#목차)**
### 조건문을 피하세요
이건 불가능한 일처럼 보일 겁니다. 이 말을 처음 들은 대부분의 사람들은 묻습니다. "어떻게 `if` 문 없이 뭔가를 할 수 있죠?"
그에 대한 답은 다형성입니다. 많은 케이스에서 같은 일을 완수하기 위해 우리는 다형성을 사용할 수 있습니다.
두 번째 질문은 일반적으로 이럴 거예요. "음, 좋습니다. 하지만 왜 제가 그렇게 해야 하죠?"
그에 대한 대답은 우리가 이전에 배운 클린코드 개념 때문입니다. '함수는 한 가지만 해야 합니다.'
`if` 문을 가진 함수와 클래스를 가지게 될 때, 우리는 우리의 함수가 한가지 이상을 한다고 사람들에게 말하는 셈입니다.
기억하세요. 딱 한 가지만 하세요.
**나쁜 예:**
```php
class Airplane
{
// ...
public function getCruisingAltitude(): int
{
switch ($this->type) {
case '777':
return $this->getMaxAltitude() - $this->getPassengerCount();
case 'Air Force One':
return $this->getMaxAltitude();
case 'Cessna':
return $this->getMaxAltitude() - $this->getFuelExpenditure();
}
}
}
```
**좋은 예:**
```php
interface Airplane
{
// ...
public function getCruisingAltitude(): int;
}
class Boeing777 implements Airplane
{
// ...
public function getCruisingAltitude(): int
{
return $this->getMaxAltitude() - $this->getPassengerCount();
}
}
class AirForceOne implements Airplane
{
// ...
public function getCruisingAltitude(): int
{
return $this->getMaxAltitude();
}
}
class Cessna implements Airplane
{
// ...
public function getCruisingAltitude(): int
{
return $this->getMaxAltitude() - $this->getFuelExpenditure();
}
}
```
**[⬆ 위로 가기](#목차)**
### 타입 체킹을 피하세요 (part 1)
PHP는 타입이 없습니다. 즉, 우리의 함수가 어떠한 타입의 인수도 가질 수 있다는 걸 뜻합니다.
때때로 우리는 이러한 자유에 물리기도 합니다. 그래서 우리의 함수 내에서 타입 체킹을 하는 것에 구미가 당기게 되곤 합니다.
이렇게 하는 것을 피하는 많은 방법이 있습니다. 고려할 첫 번째는 일관된 API입니다.