Servlet Init Parameter(서블릿 초기화 매개변수)로 web.xml에 DB 연결 정보 관리하기

• 관련 글

 - Context Parameter(컨텍스트 매개변수)로 web.xml에 DB 연결 정보 관리하기

---

Servlet Init Parameter(서블릿 초기화 매개변수)로 web.xml에 DB 연결 정보 관리하기

Servlet Init Parameter(서블릿 초기화 매개변수)

서블릿을 생성하고 초기화할 때, 즉 init()을 호출할때 서블릿 컨테이너가 서블릿에 전달하는 데이터이다. 보통 DB 연결 정보와 같은 정적인 데이터를 전달할 때 사용한다. 다음의 방법으로 설정할 수 있다.

1. DD파일(web.xml)의 서블릿 배치 정보에 설정
2. 어노테이션을 사용해서 서블릿 소스 코드에 설정

가능한 1번의 방법으로 설정하는게 좋다. 소스 코드에서 분리해서 외부 파일에 두는게 더 관리하기 쉽기 때문이다.

 

아래와 같이 DB에서 학생 목록을 가져와 출력하는 StudentListServlet 클래스가 있다. 소스 코드 안에 DB 연결 정보를 포함하고 있다.

Properties jdbcProperties = new Properties();
jdbcProperties.setProperty("user", "username");
jdbcProperties.setProperty("password", "****");
 
try {
    // 1. java.sql.Driver 인터페이스 구현체 등록
    // MySQL : com.mysql.cj.jdbc.Driver 클래스
    DriverManager.registerDriver(new com.mysql.cj.jdbc.Driver());
    conn = DriverManager.getConnection("jdbc:mysql://localhost:3307/knou", jdbcProperties);

 

이 서블릿이 DB 연결 정보를 서블릿 초기화 매개변수에서 받아서 연결할 수 있도록 코드를 변경한다.

 

web.xml 파일에 아래와 같이 StudentListServlet의 서블릿 배치 정보를 작성한다.

 

<servlet>
    <servlet-name>StudentListServlet</servlet-name>
    <servlet-class>com.atoz_develop.spms.servlets.StudentListServlet</servlet-class>
    <init-param>
        <param-name>driver</param-name>
        <param-value>com.mysql.cj.jdbc.Driver</param-value>
    </init-param>
    <init-param>
        <param-name>url</param-name>
        <param-value>jdbc:mysql://localhost:3307/knou</param-value>
    </init-param>
    <init-param>
        <param-name>username</param-name>
        <param-value>user</param-value>
    </init-param>
    <init-param>
        <param-name>password</param-name>
        <param-value>****</param-value>
    </init-param>
</servlet>
<servlet-mapping>
    <servlet-name>StudentListServlet</servlet-name>
    <url-pattern>/student/list</url-pattern>
</servlet-mapping>

<servlet> 하위의 <init-param>에 매개변수를 설정한다.

<param-name>에 매개변수 이름을, <param-value>에 매개변수 값을 설정한다.

위와 같이 <init-param>을 네개 작성해서 JDBC 드라이버 클래스, JDBC URL, 사용자 정보를 설정한다.

user와 ****에는 실제 사용자 정보를 작성해야 한다.

 

그리고 StudentListServlet의 소스 코드를 아래와 같이 수정한다.

 

/*Properties jdbcProperties = new Properties();
jdbcProperties.setProperty("user", "username");
jdbcProperties.setProperty("password", "****");*/
 
try {
    // 1. java.sql.Driver 인터페이스 구현체 등록
    // MySQL : com.mysql.cj.jdbc.Driver 클래스
    // DriverManager.registerDriver(new com.mysql.cj.jdbc.Driver());
    // conn = DriverManager.getConnection("jdbc:mysql://localhost:3307/knou", jdbcProperties);
    // 서블릿 init parameter를 이용한 JDBC 연결
    Class.forName(this.getInitParameter("driver"));
    conn = DriverManager.getConnection(
            this.getInitParameter("url"),
            this.getInitParameter("username"),
            this.getInitParameter("password")
    );
 
    stmt = conn.createStatement();

 

Servlet init parameter는 getInitParameter()를 이용해서 값을 꺼낼 수 있다.

getInitParameter()는 해당 서블릿의 배치 정보가 있는 web.xml로부터 <init-param>의 매개변수 값을 String으로 반환한다.

 

이전 방식인 DriverManager.registerDriver()에는 JDBC 드라이버 클래스의 인스턴스를 전달해야 하지만 Class.forName()에는 패키지를 포함한 클래스 이름(QName)을 전달해서 드라이버를 로딩한다.

 

수정된 위 코드는 getInitParameter()로 JDBC 드라이버 클래스, JDBC URL, 사용자 정보를 가져와서 DB에 연결하였다.

 

이처럼 자바 소스 코드 안에 직접 작성하는 것보다 초기화 매개변수를 이용하는 방식이 유지보수하는데 훨씬 낫다.

그리고 servlet init parameter는 해당 서블릿에서만 사용할 수 있으므로 DB 연결 정보와 같은 여러 서블릿에서 사용하는 값은 context param(컨텍스트 매개변수)를 통해 설정하는게 좋다.

 

[참고] Annotation에 Servlet Init Parameter 설정하기

다음과 같이 web.xml이 아닌 서블릿 소스 코드에 어노테이션으로 servlet init parameter를 설정할 수 있다.

@WebServlet(
        urlPatterns = {"/student/update"},
        initParams = {
                @WebInitParam(name="driver", value="com.mysql.cj.jdbc.Driver"),
                @WebInitParam(name="url", value="jdbc:mysql://localhost:3307/knou"),
                @WebInitParam(name="username", value="user"),
                @WebInitParam(name="password", value="****")
        }
)

 

@WebServlet 어노테이션의 initParams는 @WebInitParam의 배열로 servlet init parameter를 설정하는 속성이다.

@WebInitParam은 name(매개변수 이름), value(매개변수 값)의 필수 속성을 갖고 선택 속성인 description(설명)이 추가될 수 있다.

---

• 관련 글

 - Context Parameter(컨텍스트 매개변수)로 web.xml에 DB 연결 정보 관리하기

 

References

열혈강의 자바 웹 개발 워크북(프리렉, 2016, 엄진영)