Java Code Convention ( + Google Java Style Guide)

 

 

자바로 코드를 작성할 때에는 규칙을 유지하여 코드를 작성해야 한다. 

 

 

 

Java Code Convention의 필요성

자바 코드 컨벤션(자바 코드 규칙)는 다른 개발자가 나의 코드를 보아도 한번에 이해하여 가독성을 높이도록 하고, 코드의 유지보수성을 높이기 위해서 사용해야 한다. 이는 코드의 유지보수를 위하여 필수사항이므로 코드를 작성할 때 꼭 지켜지도록 설정하자. 

 

자바 코드의 스타일 가이드에는 구글 자바 스타일 가이드, 네이버 캠퍼스 핵데이 자바 코드 컨벤션, 오라클 자바 컨벤션 이 있다. 

 

 

Google Java Style Guide

자바 코드의 스타일 가이드중에서 가장 널리 사용되는 것은 구글의 자바스타일가이드이다. 

구글 자바 스타일 가이드는 영문으로 작성되어 있는데 다음의 블로그에서 한글로 해석하여 설명해주는 것을 참고하여 습득하는데 많은 도움을 받았다. 

https://myeonguni.tistory.com/1596

[코딩규칙] 자바 코딩 규칙(Java Code Conventions)

 

나는 이미 작성한 코드를 수정하는 과정을 거쳤는데, 다음의 경우들의 규칙을 위반한 코드를 작성했음을 알게 되었다. 

 

① 한 줄에 80자 이상 작성하지 않기 

    @PostMapping("/likePost/{postId}/{userId}")
    public LikePostDTO likePost(@PathVariable("postId")String postId, @PathVariable("userId")String userId){
        Integer post = Integer.parseInt(postId);
        Integer user = Integer.parseInt(userId);
        return likePostService.likePost(post,user);
    }

    @PostMapping("/likePost/{postId}/{userId}")
    public LikePostDTO likePost(@PathVariable("postId")String postId, 
    	@PathVariable("userId")String userId){
        Integer post = Integer.parseInt(postId);
        Integer user = Integer.parseInt(userId);
        return likePostService.likePost(post,user);
    }

한줄에 80자 이상 작성하는 것은 터미널과 툴에서 다룰 수 없기 때문에 피하는 것이 좋다. 

(주석은 일반적으로 한줄에 70자 이상 작성하지 않는다)

 

뛰어쓰기의 경우 콤마 뒤나 연산자 앞에서 끊어주도록 한다. 

 

 

 

② if-else문에서 {} 을 입력하기

 if(existingUser==null)return true;

 if(existingUser==null){
            return true;
        }

위와 같이 if else 구문에서는 다른 문장과 혼동되지 않도록 포함하고 있는 내용들에 중괄호를 꼭 작성하도록 하자. 

 

 

 

③ 들여쓰기 

        Address address = new Address(orderCreateDTO.getAddress().getName(),
                                        orderCreateDTO.getAddress().getCountry(),
                                        orderCreateDTO.getAddress().getCity(),
                                        orderCreateDTO.getAddress().getZipcode(),
                                        orderCreateDTO.getAddress().getAddress(),
                                        orderCreateDTO.getAddress().getLatitude(),
                                        orderCreateDTO.getAddress().getLongitude());

  Address address = new Address(orderCreateDTO.getAddress().getName(),
            orderCreateDTO.getAddress().getCountry(),
            orderCreateDTO.getAddress().getCity(),
            orderCreateDTO.getAddress().getZipcode(),
            orderCreateDTO.getAddress().getAddress(),
            orderCreateDTO.getAddress().getLatitude(),
            orderCreateDTO.getAddress().getLongitude());

들여쓰기의 경우 줄바꿈을 해야하는 경우라면 이전의 들여쓰기보다 4번만 더 들여쓰기 하도록 한다.

 

 

 

 

Intellij에서 Google Code Style Guide 적용하기

이미 작성한 코드나 코드를 작성할 때, 자신이 작성한 코드가 자바 코드 컨벤션에 적합한지 확인해주는 것이 필요하다. 이때, 인텔리제이에서 Google Code Style Guide를 통하여 내가 작성한 코드를 IDE의 도움을 받아 코드를 쉽게 확인할 수 있다. 

 

다음의 깃헙주소에서 intellij-java-google-style.xml파일을 저장해준다.

https://github.com/google/styleguide

GitHub - google/styleguide: Style guides for Google-originated open-source projects

 

 

 

인텔리제이의 preference로 들어가서 Code Style에서 Default로 설정된 Scheme를 새로운 파일로 변경하도록 import해준다. 여기서 다운로드한 xml파일을 적용하도록 한다. 

 

추가로 Java 항목으로 이동하여 Tabs and Indents의 원래 2로 설정된 항목은 4로 설정해준다. (들여쓰기 설정)

(만약 Spaces항목의 Assignment Operator가 선택되어 있지 않다면 선택으로 변경해준다)

 

OK를 눌러 저장하면 수정하고자 하는 자바파일에서 단축키 Command + Option + L 버튼을 눌러 손쉽게 구글자바코드스타일이 적용되도록 변경할 수 있다. 

 

 

 

(추가로 참고한 사이트)

https://055055.tistory.com/97

인텔리제이 코딩 컨벤션 설정

https://hodol.dev/journal/coding-convention/

팀 프로젝트 코딩 컨벤션 적용기 - 호돌록