개발자라면 한 번쯤 “클린 코드(Clean Code)”라는 말을 들어본 적이 있을 것입니다. 클린 코드는 읽기 쉽고 이해하기 쉬운, 말 그대로 깔끔한 코드 작성을 목표로 합니다. 이는 단순히 코드의 미관을 위해서가 아니라, 소프트웨어의 유지보수성과 개발 생산성을 극대화하기 위해 매우 중요한 역할을 합니다. 이번 글에서는 클린 코드의 정의와 왜 중요한지, 그리고 클린 코드 작성의 장점에 대해 살펴보겠습니다.

1. 클린 코드란 무엇인가?

클린 코드는 "누구나 쉽게 읽고 이해할 수 있는 코드"입니다. 주석이 거의 없어도 코드 자체만으로 기능과 목적을 파악할 수 있어야 하며, 불필요한 복잡성을 줄여 효율적으로 작성된 코드가 바로 클린 코드입니다. 이와 같은 코드를 작성하기 위해서는 의미 있는 변수명, 일관된 스타일, 간결한 함수, 논리적이고 구조화된 흐름이 필요합니다.

2. 클린 코드의 중요성

(1) 유지보수의 용이성

대부분의 소프트웨어는 개발 이후에도 지속적으로 수정되고 기능이 추가됩니다. 클린 코드는 이러한 유지보수 과정에서 큰 차이를 만듭니다. 이해하기 쉬운 코드는 새로운 개발자가 프로젝트에 참여하더라도 빠르게 코드를 이해하고 수정할 수 있게 해주며, 코드 오류를 발견하고 해결하는 데 드는 시간을 줄여줍니다.

(2) 팀 내 협업 효율성 향상

소프트웨어 개발은 주로 팀 단위로 이루어지며, 코드의 가독성은 팀원 간 원활한 소통을 위해 매우 중요합니다. 클린 코드를 작성하면 팀원 누구나 코드의 의도를 쉽게 파악할 수 있어 협업 효율이 높아집니다. 더불어 코드 리뷰가 간편해져 버그 및 오류의 사전 발견율을 높일 수 있습니다.

(3) 생산성 증대

클린 코드는 개발자의 생산성을 크게 향상시킵니다. 코드가 깔끔할수록 필요한 기능을 찾거나 특정 로직을 수정할 때 드는 시간이 줄어들어 새로운 기능을 더 빠르게 추가할 수 있습니다. 이를 통해 반복적이고 지루한 작업을 줄이고, 더 많은 시간을 창의적인 문제 해결과 혁신적인 기능 개발에 할애할 수 있습니다.

(4) 오류 및 버그 감소

복잡한 코드는 버그가 발생하기 쉽습니다. 클린 코드는 복잡성을 줄이고 가독성을 높여 코드의 품질을 유지합니다. 구조화된 코드 덕분에 버그가 발생하더라도 원인을 쉽게 파악할 수 있으며, 오류를 사전에 방지할 수 있는 규칙을 유지하게 해 줍니다.

(5) 확장성과 유연성 확보

클린 코드는 프로그램의 구조가 논리적이고 일관되므로, 확장이 필요할 때 새로운 기능을 더 쉽게 추가할 수 있습니다. 예를 들어, 새로운 모듈을 추가하거나 기존 기능을 수정하는 경우에도, 기존의 클린 코드가 좋은 기반이 되어 프로젝트가 쉽게 확장됩니다.

3. 클린 코드를 작성하는 방법

(1) 의미 있는 변수 및 함수명 사용하기

변수명과 함수명은 그 목적과 역할을 잘 나타내야 합니다. 이름만 보고도 역할을 이해할 수 있도록 하여 주석이 필요 없는 코드가 되도록 하는 것이 중요합니다.

(2) 짧고 간결한 함수 작성

각 함수는 하나의 역할만 수행하도록 작성합니다. 여러 역할을 하나의 함수에 넣으면 코드가 복잡해지고 이해하기 어려워지므로, 역할별로 함수를 나눠 간결하게 유지하는 것이 좋습니다.

(3) 일관된 코드 스타일 유지

일관된 코드 스타일을 유지하면 가독성이 크게 향상됩니다. 중괄호의 위치, 들여쓰기, 빈 줄 처리 등에서 일관된 스타일을 적용하여 코드가 일정하게 유지되도록 합니다.

(4) 주석은 필요한 경우에만

주석은 코드를 설명하기보다는 코드의 의도를 보충하거나 복잡한 로직의 이유를 설명할 때 사용하는 것이 좋습니다. 잘 작성된 클린 코드는 주석이 많지 않더라도 이해가 쉬워야 합니다.

결론

클린 코드는 단순히 코드를 보기 좋게 작성하는 것이 아닙니다. 클린 코드를 작성하는 습관은 유지보수를 간편하게 하고 협업 효율성을 높이며, 전체 소프트웨어의 품질을 향상시키는 데 중요한 역할을 합니다. 효율적인 코드 관리를 통해 궁극적으로 더 좋은 프로그램을 제공할 수 있게 해주는 클린 코드의 중요성을 잊지 말고, 개발할 때마다 클린 코드를 유지하기 위해 노력해 보세요.

현대 프로그래밍에서 객체지향 언어(Object-Oriented Programming, OOP)는 가장 널리 사용되는 프로그래밍 패러다임 중 하나입니다. OOP는 복잡한 프로그램을 구조적으로 설계하고 확장 가능하게 유지하는 데 중점을 둔 접근 방식으로, C++, Java, C#, Python과 같은 많은 프로그래밍 언어들이 객체지향 방식을 채택하고 있습니다. 이번 글에서는 객체지향 언어의 핵심적인 장점과 그로 인해 코드가 얼마나 효율적으로 관리될 수 있는지 살펴보겠습니다.

1. 코드 재사용성

객체지향 언어는 코드 재사용성을 높이는 데 큰 이점을 제공합니다. 클래스와 객체라는 구조를 통해 개발자는 필요한 기능을 한 번 구현해 두면, 여러 프로젝트나 다른 코드에서 쉽게 재사용할 수 있습니다. 이를 통해 코드 중복을 줄이고, 재사용 가능한 모듈을 활용하여 개발 시간을 단축할 수 있습니다.

2. 유지보수의 용이성

객체지향 언어에서는 프로그램을 독립적인 단위(객체)로 나눌 수 있어, 특정 기능을 수정해야 할 때 해당 객체만 수정하면 됩니다. 이 방식은 특히 대규모 프로젝트에서 유지보수를 간편하게 만들어 줍니다. 또한 캡슐화(encapsulation) 덕분에 객체 내부의 데이터가 외부에서 직접 접근할 수 없도록 보호되기 때문에 코드의 안정성을 높일 수 있습니다.

3. 높은 생산성 및 효율성

객체지향 언어는 추상화(abstraction)를 통해 복잡한 코드의 간결화가 가능하게 합니다. 중요한 부분만 집중하여 설계할 수 있기 때문에 개발자가 쉽게 프로그램을 이해하고 빠르게 기능을 구현할 수 있습니다. 이로 인해 생산성이 높아지고, 코드 작성과 디버깅의 효율성 또한 향상됩니다.

4. 확장성

OOP는 상속(inheritance)과 다형성(polymorphism)을 지원하여 새로운 기능을 추가하거나 기존 기능을 확장하는 데 유리합니다. 이미 정의된 클래스를 기반으로 새로운 클래스를 생성할 수 있기 때문에 중복된 코드를 작성하지 않아도 되고, 다형성을 통해 여러 객체가 같은 인터페이스를 통해 다양한 방식으로 동작할 수 있습니다.

5. 가독성 및 코드 이해도 향상

객체지향 언어는 클래스와 객체, 메소드와 속성 등으로 프로그램 구조를 잘 정의할 수 있습니다. 이로 인해 프로그램을 읽고 이해하기가 쉽고, 여러 명의 개발자가 협업할 때 서로의 코드 이해도도 높아집니다. 코드의 가독성이 높을수록 유지보수와 오류 해결이 간편해지므로, 개발팀 전체의 생산성에도 긍정적인 영향을 줍니다.

6. 데이터 안전성 및 보안성

객체지향 언어는 캡슐화를 통해 데이터를 보호할 수 있습니다. 객체 외부에서 내부 데이터에 접근할 수 없도록 하여 데이터가 무분별하게 수정되는 것을 방지하고, 객체가 허가된 방식으로만 데이터를 처리하도록 유도합니다. 이로 인해 중요한 데이터를 안전하게 관리하고 보안을 강화할 수 있습니다.

결론

객체지향 언어는 개발자에게 코드의 재사용성, 유지보수 용이성, 생산성 향상, 확장성, 가독성, 데이터 안전성 등 다양한 이점을 제공합니다. 이러한 장점들 덕분에 OOP는 대규모 프로젝트나 복잡한 시스템을 효율적으로 설계하고 유지할 수 있는 강력한 프로그래밍 방식으로 널리 사용되고 있습니다. 객체지향 언어를 이해하고 활용하는 것은 더욱 안정적이고 확장성 있는 소프트웨어를 개발하는 데 큰 도움이 됩니다.

1단계: 개발 환경 설정 시작하려면 컴퓨터에 Java 및 Spring Boot가 설치되어 있는지 확인하십시오. Oracle 웹 사이트에서 Java를 다운로드하고 Spring 웹 사이트에서 Spring Boot를 다운로드할 수 있습니다. IntelliJ IDEA 또는 Eclipse와 같은 IDE(통합 개발 환경)를 사용하여 개발을 더 쉽게 만들 수 있습니다.

2단계: 새 Spring Boot 프로젝트 생성 IDE를 직접 새 Spring Boot 프로젝트를 만듭니다. Build Tool로 "Maven" 또는 "Gradle"을 선택하고 프로젝트에 필요한 항목을 선택합니다. 이 경우 Spring Web, Spring Data JPA 및 Thymeleaf가 필요합니다.

3단계: 데이터베이스 설정 게시되는 메시지에 대한 정보를 저장하려면 게시판 앱에 데이터베이스가 필요합니다. Spring Boot를 사용하면 데이터베이스 연결을 쉽게 목록화할 수 있습니다. MySQL 또는 PostgreSQL과 유사하게 원하는 관계형 데이터베이스를 선택하고 application.properties 파일에서 연결 세부 정보를 구성할 수 있습니다.

4단계: 메시지 접촉을 만들기 게시판에 게시되는 메시지를 나타내는 "메시지"라는 새 Java 클래스를 제외합니다. 메시지 엔터티에는 id, 제목, 정보 및 타임스탬프와 같은 속성이 있어야 합니다.

5단계: 메시지 리포지토리 생성 JpaRepository를 확장하는 "MessageRepository"라는 새 인터페이스를 제외합니다. 이 인터페이스를 사용하면 데이터베이스와 연결하고 메시지 엔터티에서 CRUD(만들기, 읽기, 업데이트, 삭제) 작업을 수행할 수 있습니다.

6단계: 컨트롤러 만들기 사용자 인터페이스의 HTTP 요청을 처리하기 위해 "MessageController"라는 새 Java 클래스를 문서화합니다. @Controller 및 @RequestMapping과 같은 주석을 사용하여 HTTP 요청을 컨트롤러의 특정 메서드에 반환할 수 있습니다.

7단계: 사용자 인터페이스 만들기 HTML, CSS 및 Thymeleaf를 사용하여 게시판 앱의 사용자 인터페이스를 만듭니다. 사용자가 새 메시지를 작성하고 기존 메시지를 목록에 표시할 수 있도록 양식을 지정할 수 있습니다.

8단계: 앱 테스트 로컬에서 앱을 실행하고 모든 것이 예상대로 작동하는지 확인하여 앱을 테스트합니다. Postman과 같은 도구를 사용하여 API 끝점을 테스트하고 사용자 인터페이스를 확인하여 메시지가 올바르게 표시되는지 확인할 수 있습니다.

서버 실행

firstproject 프로젝트 -> src -> java  내부에 들어가면 firstprojectApplication 을 열면

메인메서드가 포함된 자바코드가 있다

java 폴더에는 자바코드 / resource 폴더에는 외부파일이 저장된

ctrl + shift + F10 누르면 콘솔에 뭐가 쭉~~ 뜨면서 start 어쩌고 저쩌고 하고 뜬다

중간에 보안관련 팝업 하면 액세스 허용 해주면 된다

톰캣이 내장되어있는건지 , 톰캣을 설치해둬서 그냥 실행되는건진 잘 모르겠는데

따로 설정하지 않았는데 그냥 톰캣 서버가 실행되는거보면 내장되어있는게 맞는 것 같다.

(책에 보니 스프링부트에 톰캣이 내장되어있다고 한다)

localhost:8080 에 접속해보면 

이렇게 뜨면 정상적으로 서버가 실행된것이다

HTML 파일 생성

resource -> static 폴더에 우크릭 -> HTML 파일 생성 (hello.html 생성)

hello world 문구 하나 작성해주고 저장 /

좌측 하단 버튼 눌러서 서버 새로고침 해주고 localhost:8080/hello.html 에 접속하면

정상적으로 출력

기본적으로 localhost:8080/hello.html 같이 직접적으로 주소를 지정할경우

resource -> static 폴더에서 파일을 찾는다

Open JDK17 설치 

현재 자신의 자바 버전 확인

커맨드 프롬프트에서 java -version 으로 자신의 버전 확인

현재 11.0.18 버전으로 설치되어있어서 JDK 17 버전을 추가로 설치

https://adoptium.net/temurin/releases/

홈페이지에서 자신의 운영체제에 맞게 17버전을 다운로드하여 설치

맥은 홈브류로 설치 가능 (실리콘맥 m1,m2는 오라클 OpenJDK 로 설치해야함)

IDE 설치( intelliJ 인텔리제이)

현재 자바 환경은 이클립스로 사용해왔는데 실습간 교재와 같은환경 조성을 위해 인텔리제이를 처음 설치해봄

인텔리제이는 유료라는 생각을 항상 갖고있어 사용해보지 않았는데 무료버전은 Community 에디션이 있다

https://www.jetbrains.com/ko-kr/idea/download/#section=windows

유료 무료 버전 기능차이가 꽤 크다 . 

다운로드 받은후 기본설정으로 설치

SpringBoot 프로젝트 만들기

Spring Initializr 를 사용하여 프로젝트를 생성

https://start.spring.io/

링크에 접속하여 다음과 같이 설정 (Project Metadata 는 artifect 만 firstproject 로 변경하면 자동으로 나머지도 바뀜)

Ctrl+B 또는 Add dependecies 를 눌러 Spring Web,

H2 Database (자료저장을 위한 데이터베이스) ,

Muistache(화면을 만들기 위해 필요한 도구) ,

Spring Data JPA ( 데이터베이스를 다루기 편하게 하는 도구)를 눌러 추가

하단 generate 눌러 firstproject.zip 파일을 내려 받고 c드라이브에 압축을 풀어준다

IntelliJ에서 프로젝트 불러오기

인텔리제이 실행후 open 버튼을 눌러 firstproject 폴더 지정후 오픈 -> 체크박스 체크하고 -> trustproject 버튼 클릭

나같은경우는 프로젝트 생성시 오류 발생

구글링해보니 OpenJDK 버전이 맞지 않아서....

 이럴경우 File -> setting 에 들어가서

Gradle JVM 에서 버전을 프로젝트 생성할시 설정한 17 버전으로 맞춰준다

그러면 정상적으로 프로젝트가 build 된다

최근 오라클 연동하여 자바하는 수업에 들어가기 시작하면서 뭔가 멘붕이 와버렸다...

잠깐 딴생각 하니 금방금방 수업진도를 놓쳐서 ㅠㅠㅠ

유료 결제 해놓은 chatGPT 를 써먹어야겠다 싶어서 ㅋ

기본적인것 부터!

GPT4 모델로 진행. 깔끔하게 작성해주는데 속도가 좀 느리다.

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;

public class OracleConnectionExample {

    public static void main(String[] args) {
        try {
            // 1. 드라이버 로드
            Class.forName("oracle.jdbc.driver.OracleDriver");

            // 2. 연결
            String url = "jdbc:oracle:thin:@localhost:1521:xe";
            String user = "your_username";
            String password = "your_password";
            Connection connection = DriverManager.getConnection(url, user, password);

            // 3. 명령문 생성
            Statement statement = connection.createStatement();

            // 4. 쿼리 실행
            ResultSet resultSet = statement.executeQuery("SELECT * FROM your_table");

            // 5. 결과 처리
            while (resultSet.next()) {
                System.out.println(resultSet.getString("column_name"));
            }

            // 6. 자원 해제
            resultSet.close();
            statement.close();
            connection.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

위 예제에서는 다음과 같은 단계를 거칩니다.

1. 드라이버 로드: 오라클 JDBC 드라이버를 메모리에 로드합니다.
2. 연결: 데이터베이스에 연결합니다. 연결 정보를 수정하여 자신의 환경에 맞게 설정하세요.
3. 명령문 생성: 데이터베이스에 전달할 SQL 명령문을 생성합니다.
4. 쿼리 실행: 명령문을 실행하고 결과를 ResultSet 객체에 저장합니다.
5. 결과 처리: ResultSet 객체에서 결과를 가져와 처리합니다.
6. 자원 해제: 사용한 자원을 해제합니다.

이 예제를 참고하여 자바와 오라클을 연동하실 수 있습니다.

역시 똑똑해. 확실히 이전버전 gpt 보다 조금더 똘똘한것 같다