Java 코드 컨벤션

// 계산기 Class를 만들어보았습니다. 무엇이 잘못 되었을까요? public class cal{ private int NumberOne; private int numberTwo; public cal(int num1, int Num2){ NumberOne = num1; numberTwo = Num2; } public void ADD(){ int result=NumberOne +numberTwo; System.out.println(result); } public static void main(String[] args){ cal calc = new cal(5,10); calc.ADD(); } }

// 패키지 이름은 소문자를 사용합니다. 단어별 구문을 위해 언더스코어(_)나 대문자를 포함하지 않습니다 // 좋은 예 package com.sparta.api package com.sparta.userapi // 나쁜 예 package com.sparta.user_api package com.sparta.userApi

// 패키지 이름은 소문자를 사용합니다. 단어별 구문을 위해 언더스코어(_)나 대문자를 포함하지 않습니다 // 좋은 예 public class ContentHandler public class ContentHandlerTest public interface ContentHandlerFactory public interface Closable // 나쁜 예 public class contentHandler public interface contenthandlerfactory

// 좋은 예 private int userAge; // 나쁜 예 private int a;

// 좋은 예 동사사용 -> validateNumber() 동사 + 전치사 + 명사 -> mapToInt(), moveToDirectory(), copyToFile(), submitToExecutor() 전환메서드의 전치사 -> toString(), toModel();, fromTable(); of(), Builder 패턴 적용한 클래스의 메서드의 전치사 -> User.build().withUserId(id); // 보통 method 이름을 지을 때 대칭되는 기능을 만드는 경우가 많습니다. add / remove append / prepend start / stop begin / end first / last top / last // 진위(참,거짓)를 나타내는 경우 isXXX / hasXXX / canXXX / exists / contains / equals isNull(), isNumber(), hasConnection(), canSave() 등 public boolean hasConnetion() { return true; }

// 좋은 예 public final int UNLIMITED = -1; public final String HTTP_EXPRESSION = “POST”; // 나쁜 예 public final int unlimited = -1; public final String http_expression = “POST”;

// 좋은 예 InputParser inputParser = new InputParser(); OutputParser outputParser = new OutputParser(); ParserHandler parserHandler = new ParserHandler(); // 나쁜 예 InputParser p = new InputParser(); OutputParser parser = new OutputParser(); - 여러 종류의 parser가 동일한 {} 안에 있을 시 가독성이 떨어집니다. ParserHandler ph = new ParserHandler(); - 약어를 사용할 시 정의되어 있거나 유추할 수 있는 약어로 작성해야 합니다.

// 좋은 예 import java.util.List; import java.util.ArrayList; import static org.junit.jupiter.api.Assertions.*; // 나쁜 예 import java.util.*; // 위와 같은 경우를 방지하려면 intellij-settings에서 아래 붉은 박스 안에 숫자를 증가시킵니다.

// 좋은 예 public static final String CONFIG = "상수"; protected abstract String abstractMethod() {}; // 나쁜 예 public final static String CONFIG = "상수";

// 좋은 예 @Stable private final byte[] value; // 나쁜 예 @Serial private static final long serialVersionUID = -6849794470754667710L;

// 좋은 예 private final byte coder; private int hash; private int size; // 나쁜 예 private final byte coder; private int hash; int length, size;

// 좋은 예 String[] names; // 나쁜 예 String names[];

// 좋은 예 long base = 54423234211L; // 나쁜 예 long base = 54423234211l;

// 좋은 예 public static Path of(URI uri) { String scheme = uri.getScheme(); if (scheme == null) { throw new IllegalArgumentException("Missing scheme"); } if (scheme.equalsIgnoreCase("file")) { return FileSystems.getDefault().provider().getPath(uri); } for (FileSystemProvider provider: FileSystemProvider.installedProviders()) { if (provider.getScheme().equalsIgnoreCase(scheme)) { return provider.getPath(uri); } } throw new FileSystemNotFoundException("Provider \"" + scheme + "\" not installed"); } // 나쁜 예 public static Path of(URI uri){ String scheme =uri.getScheme(); if(scheme == null){ throw new IllegalArgumentException("Missing scheme"); } if (scheme.equalsIgnoreCase("file")){ return FileSystems.getDefault().provider().getPath(uri); } for(FileSystemProvider provider: FileSystemProvider.installedProviders()){ if (provider.getScheme().equalsIgnoreCase(scheme)){ return provider.getPath(uri); } } throw new FileSystemNotFoundException("Provider \"" + scheme + "\" not installed"); }

// 좋은 예 public static WritableByteChannel newChannel(OutputStream out) { Objects.requireNonNull(out, "out"); if (out.getClass() == FileOutputStream.class) { return ((FileOutputStream) out).getChannel(); } return new WritableByteChannelImpl(out); } // 나쁜 예 public final class Channels { public static WritableByteChannel newChannel(OutputStream out) { Objects.requireNonNull(out, "out"); if (out.getClass() == FileOutputStream.class) { return ((FileOutputStream) out).getChannel(); } return new WritableByteChannelImpl(out); } }

// 좋은 예 if (condition) { System.out.println("hi"); } doSomething(); // 나쁜 예 if (condition) System.out.println("hi"); doSomething(); <- 실행될 수 있음

// 좋은 예 if (line.startWith(WARNING_PREFIX)) { return LogPattern.WARN; } else if (line.startWith(DANGER_PREFIX)) { return LogPattern.NORMAL; } else { return LogPattern.NORMAL; } // 나쁜 예 if (line.startWith(WARNING_PREFIX)) { return LogPattern.WARN; } else if (line.startWith(DANGER_PREFIX)) { return LogPattern.DANGER; } else { return LogPattern.NORMAL; } // 좋은 예 try { writeLog(); } catch (IOException ioe) { reportFailure(ioe); } finally { writeFooter(); } // 나쁜 예 try { writeLog(); } catch (IOException ioe) { reportFailure(ioe); } finally { writeFooter(); }

// 예 public class longImplemnts implements AutoClosable, Runnable, Serializable { public MyExampleClass() throws IOException, IllegalArgumentException { // 소괄호 이후 줄바꿈 performCalculation( 10, 20, "Result"); // 콤마(,) 이후 줄바꿈 List<String> items = Arrays.asList( "Apple", "Banana", "Cherry" ); // 연산자 앞에서 줄바꿈 int result = 5 + 10 - 2 * 3 / 4; boolean isValid = (result > 10) && (result != 0) || (result < 20); // 메소드 체이닝에서 . 전 줄바꿈 String formattedString = new StringBuilder() .append("The result is: ") .append(result) .toString(); } }

// 좋은 예 public void setId(int id) { this.id = id; } public void setName(String name) { this.name = name; } // 나쁜 예 public void setId(int id) { this.id = id; } public void setName(String name) { this.name = name; } public void setAge(int age) { this.age = age; }

// 좋은 예 String[] spells = new String[] {"ㄱ", "ㄴ", "ㄷ"}; // 나쁜 예 String[]spells = new String[]{"ㄱ", "ㄴ", "ㄷ"};

// 좋은 예 public void print(String line) { ... } // 나쁜 예 public void print(String line){ ... } // 좋은 예 public void example() { // if 문 - 소괄호 앞에 공백 if (condition) { System.out.println("Condition is true"); } // for 문 - 소괄호 앞에 공백 for (int i = 0; i < 10; i++) { System.out.println("Iteration: " + i); } // while 문 - 소괄호 앞에 공백 while (condition) { System.out.println("Still true"); } // catch 문 - 소괄호 앞에 공백 try { riskyOperation(); } catch (Exception e) { System.out.println("Exception caught"); } // synchronized 블록 - 소괄호 앞에 공백 synchronized (this) { System.out.println("Synchronized block"); } // switch 문 - 소괄호 앞에 공백 switch (value) { case 1: System.out.println("Value is 1"); break; case 2: System.out.println("Value is 2"); break; default: System.out.println("Other value"); } } // 나쁜 예 public void example() { if(condition){ System.out.println("Condition is true"); } for(int i=0;i<10;i++){ System.out.println("Iteration: " + i); } while(condition){ System.out.println("Still true"); } try{ riskyOperation(); }catch (Exception e){ System.out.println("Exception caught"); } synchronized (this){ System.out.println("Synchronized block"); } // switch 문 - 소괄호 앞에 공백 switch(value){ case 1: System.out.println("Value is 1"); break; case 2: System.out.println("Value is 2"); break; default: System.out.println("Other value"); } } // 좋은 예 String message = (String) line; boolean flag = (condition1 && condition2) // 나쁜 예 String message = ( String ) rawLine; boolean flag = ( condition1&&condition2 )

// 좋은 예 int finalScore += weight * rawScore - absentCount; boolean flag = (isNew) ? "신규" : "기존"; // 나쁜 예 int finalScore += weight*rawScore-absentCount; boolean flag = (isNew)?"신규":"기존";

// 사용자 로그인 상태 확인 if (user.isLoggedIn()) { // 처리 로직 }

/** * 주어진 채널에서 바이트를 디코딩하여 리더(reader)를 생성합니다. * * 생성된 스트림에는 최소 {@code minBufferCap} 바이트의 내부 입력 버퍼가 포함됩니다. * 스트림의 {@code read} 메서드는 필요에 따라 기본 채널에서 바이트를 읽어 버퍼를 채웁니다. * 채널이 바이트를 읽을 때 논블로킹(non-blocking) 모드에 있으면 {@link IllegalBlockingModeException} * 예외가 발생합니다. 생성된 스트림은 그 외에는 버퍼링되지 않으며, {@link Reader#mark mark} 또는 * {@link Reader#reset reset} 메서드를 지원하지 않습니다. 스트림을 닫으면 채널도 함께 닫힙니다 * * @param ch * 바이트를 읽을 채널 * * @param dec * 사용할 문자셋 디코더 * * @param minBufferCap * 내부 바이트 버퍼의 최소 용량, * 또는 구현에 따라 기본 용량을 사용하려면 {@code -1} * * @return 새로운 리더(reader) * @throw IOException */ public static Reader newReader(ReadableByteChannel ch, CharsetDecoder dec, int minBufferCap) throws IOException {

// 꼭 주석을 달아야만 코드를 이해할 수 있어야할까요? // 직원에게 복지 혜택을 받을 자격이 있는지 검사한다. if ((employee.flag && HOURLY_FLAG) && (employee.age > 65)) if (employee.isEligibleForFullBenefits())

java 코드 복사 // 데이터베이스가 비동기적으로 업데이트되었는지를 확인하고 최신 상태를 가져오기 위함 if (isDatabaseUpdated()) { refreshData(); }

java 코드 복사 // WARNING: 이 메서드는 null 값을 반환할 수 있으므로 null 체크가 필요 public String getUserName(int userId) { // ... return null; // 사용자가 존재하지 않을 때 null을 반환합니다. }

java 코드 복사 // TODO: 이 메서드에 예외 처리를 추가 public void processOrder(Order order) { // 주문 처리 로직 }

// 좋은 예 public int calculateDiscount(Customer customer) { if (customer == null) { throw new IllegalArgumentException("Customer cannot be null"); } // 계산 로직 return discount; } // 나쁜 예 public int calculateDiscount(Customer customer) { if (customer == null) { return -1; // 오류를 반환 값으로 처리 } // 계산 로직 return discount; }

// 좋은 예 try { // 위험한 작업 } catch (Exception e) { // 예외를 기록하고 다시 던지거나 적절히 처리 logger.error("Exception occurred", e); throw e; } // 나쁜 예 try { // 위험한 작업 } catch (Exception e) { // 아무것도 하지 않음 }

try { // 파일을 읽음 } catch (FileNotFoundException e) { // 복구할 수 있는 예외: 파일을 다시 요청하거나 기본 파일을 사용 logger.error("File not found, please check the file path."); } catch (IOException e) { // 복구할 수 없는 예외: 로그를 기록하고 예외를 다시 던짐 logger.error("IOException occurred while reading the file", e); throw new RuntimeException(e); }

// 메소드를 호출한 주체는 메소드가 전달한 예외처리할 의무가 있습니다. try { file.openFile(path); } catch(FileNotFoundExcetion e) { // 예외 처리 ... } public void openFile(String filePath) throws FileNotFoundException { File file = new File(filePath); if (!file.exists()) { throw new FileNotFoundException("File not found at path: " + filePath); } }

// 좋은 예 try { // 작업 } catch (FileNotFoundException e) { // 파일이 없을 때의 처리 } catch (IOException e) { // 입출력 오류 처리 } // 나쁜 예 try { // 작업 } catch (Exception e) { // 오류 처리 }

// 좋은 예 public List<Item> getItems(Customer customer) { if (customer == null) { return Collections.emptyList(); // 빈 리스트 반환 } return customer.getItems(); } // 호출하는 쪽에서 null 체크 불필요 for (Item item : getItems(customer)) { processItem(item); } // 좋은 예 public Optional<Item> findItemById(int id) { Item item = findItemInDatabase(id); return Optional.ofNullable(item); // null 대신 Optional 반환 } // 호출하는 쪽에서 더 명확하게 null 여부를 처리 findItemById(123).ifPresent(item -> processItem(item)); // 나쁜 예 public List<Item> getItems(Customer customer) { if (customer == null) { return null; // null 반환 } return customer.getItems(); } // 호출하는 쪽에서는 null 체크를 강제로 해야 함 List<Item> items = getItems(customer); if (items != null) { for (Item item : items) { processItem(item); } }

// 좋은 예 public void processOrder(Order order) { // Null이 아닌, 항상 유효한 객체를 전달받는다고 가정 // 따라서 별도의 null 체크가 필요하지 않음 } // 호출할 때 null 대신 빈 객체를 전달 Order emptyOrder = new Order(); // 빈 객체 생성 processOrder(emptyOrder); // 나쁜 예 public void processOrder(Order order) { if (order != null) { // 처리 로직 } } // 호출 시 null을 전달하는 나쁜 습관 processOrder(null);