ldap그룹 정보의 uniquemember  삭제 .

netscape와 java api를 이용한 방법.

 

// netscape  api 이용.

 public void testRemoveUniqueMember() throws NamingException  {
  LDAPConnection ldapCon = getLdapConnection();

  boolean flag = false;
  String uniqueUserDn= "uid=123,cn=11,cn=users,dc=test,dc=co,dc=kr"; 

  String dn = "cn=11,cn=groups,dc=test,dc=co,dc=kr";
    try {
     LDAPModificationSet mods = new LDAPModificationSet();
     LDAPAttribute attr = new LDAPAttribute("uniquemember", fullDn);
     mods.add(LDAPModification.DELETE, attr);
     ldapCon.modify(dn, mods);
     flag = true;
    } catch (LDAPException e) {
     e.printStackTrace();
   
    }

 }


// java api이용
public void testRemoveUniqueMember() throws NamingException  {
    DirContext    ctx  = null;
    ctx  = getLdapConnection(); // ldap 접속
    ModificationItem[] modificationItems = new ModificationItem[1];
   

    String dn= "uid=123,cn=11,cn=users,dc=test,dc=co,dc=kr";  

    String uniqueUserDn= "cn=11,cn=groups,dc=test,dc=co,dc=kr"
    modificationItems = new ModificationItem[1];
    modificationItems[0] = new ModificationItem(ctx.REMOVE_ATTRIBUTE, new BasicAttribute("uniqueMember", uniqueUserDn));
    ctx.modifyAttributes(dn, modificationItems);

}

package test;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Hashtable;

import javax.naming.NamingEnumeration;
import javax.naming.directory.Attributes;
import javax.naming.directory.BasicAttributes;
import javax.naming.directory.DirContext;
import javax.naming.directory.InitialDirContext;
import javax.naming.directory.SearchControls;
import javax.naming.directory.SearchResult;

public class theLdap {
 public static void main(String aaa[]){
  PreparedStatement  pstmt = null;
  ResultSet    rs  = null;
  Connection    conn = null;
  DirContext    ctx  = null;
  NamingEnumeration m_ne = null;
 
  theLdap dao = new theLdap();
 
  try {
 
         ctx  = getLdapConnection(); // ldap 접속
        
        
        
         String[] attrIDs = {"cn", "sn", "employeeNumber", "businessCategory", "description", "carLicense", "displayName","homePhone","registeredAddress","userpassword"};
         //파라미터로 넘어온 인증서 일련번호를 가지고 LDAP filter를 조립
         String filter = "(uid=22)";
         SearchResult sr = null;
         SearchControls constraints = new SearchControls();

            //검색범위를 하위디렉토까지 검색(SUBTREE)
         //OBJECT_SCOPE
         //이름 첨부 객체를 검색합니다. 
         //ONELEVEL_SCOPE
         //이름 첨부 컨텍스트 의 1개 의 레벨을 검색합니다. 
         //SUBTREE_SCOPE
            constraints.setSearchScope(SearchControls.SUBTREE_SCOPE);
           
            if (attrIDs != null)
                constraints.setReturningAttributes(attrIDs);
            //검색을 시작할 BASE DN을 설정하고, 검색
            m_ne = ctx.search("CN=USERS", filter, constraints);
           
            if(m_ne != null){
             while(m_ne.hasMoreElements()){
              //System.out.println(m_ne.nextElement());
              sr = (SearchResult)m_ne.next();
              //dn출력시 BASE DN은 제외하고 출력된다.
              System.out.println(sr.getName()+","+"dc=or,dc=kr");
              for (int i=0; i< attrIDs.length; i++) { //attrIDs member count
               System.out.println(i + ": " + attrIDs[i] + " : " +
                     sr.getAttributes().get(attrIDs[i]).get());
              }
             }
            }

 

         /*
          // 수정.
         while(rs.next()){
    ModificationItem[] modItem = new ModificationItem[8]; // 수정할 아이템의 생성
   
          // 속성값 수정.
    //modItem[0] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE, new BasicAttribute("mail", "geisel@wizards.com"));
          // 속성값 추가
    //modItem[1] = new ModificationItem(DirContext.ADD_ATTRIBUTE, new BasicAttribute("telephonenumber", "+1 555 555 5555"));
          // 속성값 삭제 jpegphoto
    //modItem[2] = new ModificationItem(DirContext.REMOVE_ATTRIBUTE, new BasicAttribute("jpegphoto"));
   
   
    modItem[0] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE,new BasicAttribute("cn", rs.getString("NMKO") == null ? "" : rs.getString("NMKO")));
    modItem[1] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE,new BasicAttribute("businessCategory","businessCategory")); //rs.getString("BIZCD") == null ? "" : rs.getString("BIZCD")));
    modItem[2] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE,new BasicAttribute("description", "description")); //rs.getString("DEPTCD") == null ? "" : rs.getString("DEPTCD")));
    modItem[3] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE,new BasicAttribute("carLicense", "carLicense")); //rs.getString("PSID") == null ? "" : rs.getString("PSID")));
       modItem[4] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE,new BasicAttribute("displayName","displayName")); //rs.getString("NMKO") == null ? "" : rs.getString("NMKO")));
    modItem[5] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE,new BasicAttribute("homePhone", "homePhone")); //rs.getString("EMPTEL") == null ? "" : rs.getString("EMPTEL")));
    modItem[6] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE,new BasicAttribute("registeredAddress", "registeredAddress")); //rs.getString("EMAIL") == null ? "" : rs.getString("EMAIL")));
    modItem[7] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE,new BasicAttribute("userpassword", "userpassword")); //rs.getString("PSWD") == null ? "" : rs.getString("PSWD")));
    //modItem[8] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE,new BasicAttribute("sn", rs.getString("EMPID") == null ? "" : rs.getString("EMPID")));
    //modItem[9] = new ModificationItem(DirContext.REPLACE_ATTRIBUTE,new BasicAttribute("employeeNumber", rs.getString("EMPID") == null ? "" : rs.getString("EMPID")));
   
   
          // Perform requested modifications on named object
    ctx.modifyAttributes("uid="+rs.getString("EMPID")+",cn=users", modItem); //ldap정보 수정.
         }
   */
        
         /*
          // 삭제
         while(rs.next()){
          ctx.destroySubcontext("uid="+rs.getString("EMPID")+",cn=users"); //ldap정보  삭제
         }
         */
         /*
          // 등록.
   while(rs.next()){
    try{
     ctx.destroySubcontext("uid="+rs.getString("EMPID")+",cn=users"); //ldap정보  삭제
     System.out.println("삭제 성공");
    }catch(Exception e){
     System.out.println("삭제 실패");
    }
   
    Attributes mods = new BasicAttributes(true);
     mods.put("objectclass","top");
    mods.put("objectclass","person");
    mods.put("objectclass","organizationalPerson");
    mods.put("objectclass","inetOrgPerson");
    mods.put("cn",rs.getString("NMKO") == null ? "" : rs.getString("NMKO")); //이름
    mods.put("sn",rs.getString("EMPID") == null ? "" : rs.getString("EMPID")); //성
    mods.put("employeeNumber",rs.getString("EMPID") == null ? "" : rs.getString("EMPID"));
    mods.put("businessCategory",rs.getString("BIZCD") == null ? "" : rs.getString("BIZCD"));
    mods.put("description",rs.getString("DEPTCD") == null ? "" : rs.getString("DEPTCD"));
    mods.put("carLicense",rs.getString("PSID") == null ? "" : rs.getString("PSID"));
    mods.put("displayName",rs.getString("NMKO") == null ? "" : rs.getString("NMKO"));
    mods.put("homePhone",rs.getString("EMPTEL") == null ? "" : rs.getString("EMPTEL"));
    mods.put("registeredAddress",rs.getString("EMAIL") == null ? "" : rs.getString("EMAIL"));
    mods.put("userpassword",rs.getString("PSWD") == null ? "" : rs.getString("PSWD"));
   
   
   
    ctx.createSubcontext("uid="+rs.getString("EMPID")+",cn=users", mods);
   }
   */
   System.out.println("==================성공========================");
   close(ctx ,pstmt,rs,conn); 
  }catch(Exception e){
   close(ctx ,pstmt,rs,conn);
   e.printStackTrace();
  }finally{
   close(ctx ,pstmt,rs,conn);
  }
 }
 

 

 
 /**
  * 커넥션 닫기.
  * @param ctx
  * @param pstmt
  * @param rs
  * @param conn
  */
 public static void close( DirContext  ctx ,
      PreparedStatement  pstmt ,
      ResultSet    rs  ,
      Connection    conn)
 {
  if(rs != null) try { rs.close(); } catch(SQLException e){ e.printStackTrace(); }
  if(pstmt!= null) try { pstmt.close();} catch(SQLException e){ e.printStackTrace(); }
  if(conn != null) try { conn.close();} catch(SQLException e){ e.printStackTrace(); }
  if(ctx != null) try { ctx.close(); } catch(Exception e){ e.printStackTrace(); }
 }
 
 /**
  * ldap 커넥션.
  * @return
  */
 public static DirContext getLdapConnection(){
  Hashtable htable = new Hashtable();
  DirContext initCtx1 = null;
  DirContext ctx = null;
  try{
   // connection 정보
   htable.put("java.naming.factory.initial", "com.sun.jndi.ldap.LdapCtxFactory");
   htable.put("java.naming.security.authentication", "Simple");
   htable.put("java.naming.provider.url", "ldap://localhost:389");
   htable.put("java.naming.security.principal", "cn=test");
   htable.put("java.naming.security.credentials", "test1");
   initCtx1 = new InitialDirContext(htable);
   ctx = (DirContext) initCtx1.lookup("dc=or,dc=kr");
   return ctx;
  }catch(Exception e){
   e.printStackTrace();
  }
  return ctx;
 }
}

 

Java 코딩 지침(2004/4/14)

심우곤(wgshim) 그린벨시스템즈 정보기술연구소

본 문서는 Geotechnical Software 에서 작성한 2004 년 1월 버전의 Geosoft 의 Java Programming Style Guidelines 문서를 근간으로 하여 Sun 의 코딩 표준 권고안 및 기타 표준안들을 참고하여 작성한 것입니다. 개선된 사항을 반영하기 위하여 예고없이 변경될 수 있으며 본 문건을 통해 발생한 문제에 대해 책임을 지지 않습니다.


목 차


1 들어가기

본 문서는 Java 개발자 커뮤니티 내에서 보편적인 Java 코딩 권고안들을 나열하고 있습니다. 이 권고안들은 이미 널리 표준으로 받아들여지고 있는 몇몇 문건들(예를 들면, [1], [2], [3], [4], [5])에 기반을 두고 있으며, 전세계의 수 많은 소프트웨어 전문가들의 피드백을 받아들여 작성되었습니다. 기존 지침들이 갖는 주된 단점은, 지침들이 너무 일반적이다보니 보다 구체적이고 상세한 규칙들(예를 들면, 명명 규칙:naming rule)이 확립되어야 할 필요가 있다는 것입니이다. 따라서, 본 지침은 여타의 지침들에 비하여 프로젝트의 코드 검토 단계에 사용하기 용이하도록 각 항목마다 주석과 예제를 두었습니다. 추가적으로, 일반적으로 프로그래밍 권고안들은 코딩 스타일 이슈와 언어 고유한 기술적 이슈들을 혼합하여 기술함으로써 혼란을 초래하는 경향이 있기 때문에, 본 문서에서는 Java 언어의 기술적인 권고안에 대해서 일절 언급하지 않고 오로지 프로그래밍 스타일에 대해서만 다루고자 합니다. IDE 도구를 사용하는 개발 환경에서는 접근제한자, 키워드/문법 하일라이팅, 자동 포맷팅 등을 제공하여 가독성을 향상시킬 수 있을 것입니다. 하지만 프로그래머라면 절대로 그러한 기능에 종속되어서는 안됩니다. 소스 코드를 단순히 IDE 도구 내에서 개발되는 코드뿐 아니라 더 큰/다양한 범위로 확대하여야 하며, 어떠한 IDE 도구를 사용하는지와 상관없이 가독성을 극대화할 수 있도록 소스 코드를 작성하여야만 합니다.

1.1 권고안 레이아웃

권고안들은 주제별로 그룹지어져 있으며, 각각의 권고안들은 코드 검토 시 손쉽게 참조할 수 있도록 숫자를 부여하였습니다. 본 문서에서 사용할 권고안 레이아웃은 다음과 같습니다:

지침에 대한 간략한 설명
적용이 가능한 경우, 적용사례
동기(motivation), 배경 및 추가적인 정보

동기 섹션은 중요합니다. 코딩 표준과 지침들은 일종의 "성전(聖戰)" 과 같은 성격을 띄기 마련입니다. 따라서 각 권고안의 배경을 언급하는 것은 중요합니다.

1.2 권고안의 중요도

지침 섹션에서 사용되는 반드시 한다(must), 한다(should), 할 수 있다(can) 와 같은 용어들은 특별한 의미를 가집니다. 반드시 한다는 필히 준수해야 한다는 것을, 한다는 강한 권고를, 할 수 있다는 일반적인 지침을 의미합니다.

2 일반적인 지침들

1. 가독성을 증진시킬 수 있는 타당한 이유가 있다면 본 지침을 어길 수도 있다.
 
본 지침의 궁극적인 목표는 가독성을 향상시키는 것입니다. 가독성이 향상되면 이해가 용이해지고 유지보수가 수월해지며 일반적으로 코드의 품질도 좋아집니다. 일반적인 지침을 거론하는 본 지침서에서 모든 상황들을 감안한 지침을 제공해 드릴 수 없기 때문에, 프로그래머의 판단에 의하여 가변적으로 활용하실 수 있습니다.

3 명명 관례(Naming Conventions)

3.1 일반적인 명명 관례

2. 패키지를 표현하는 이름은 모두 소문자를 사용한다.
mypackage, com.company.application.ui
이 패키지 명명 관례는 Java 핵심 패키지들의 명명에 Sun 社 가 사용하고 있는 것입니다. 패키지 이름의 시작부는 반드시 도메인 이름으로 소문자를 사용해야만 합니다.
3. 타입을 표현하는 이름은 대소문자를 혼용할 수 있지만, 반드시 명사를 사용하고 시작 글자를 대문자로 지정한다.
Account, EventHandler
Java 개발자 커뮤니티에서 사용하는 일반적인 관습이며, Sun 社 가 Java 핵심 패키지들의 타입 명명에 사용하고 있는 것입니다.
4. 변수의 이름은 대소문자를 혼용할 수 있지만 반드시 소문자로 시작한다.
account, eventHandler
Java 개발자 커뮤니티에서 사용하는 일반적인 관습이며, Sun 社 가 Java 핵심 패키지들의 변수이름 명명에 사용하고 있는 것입니다. 변수와 타입을 손쉽게 구별할 수 있도록 하면, 이름의 충돌이 발생하는 것을 효과적으로 해결할 수 있게 됩니다. 예) Account account; // 선언문
5. 상수(final 변수)를 표현하는 이름은 반드시 모두 대문자로 지정하되 '_' 를 사용하여 단어들을 구분한다.
MAX_ITERATIONS, COLOR_RED
Java 개발자 커뮤니티에서 사용하는 일반적인 관습이며, Sun 社 가 Java 핵심 패키지에 사용하고 있는 것입니다. 일반적으로, 이러한 상수의 사용은 최소화해야만 합니다. 대다수의 경우 상수 변수를 메소드로 구현하는 것이 더 낫습니다:
int getMaxIterations()     // NOT: MAX_ITERATIONS = 25
{
  return 25;
}

이러한 양식이 보다 읽기에 편하며, 클래스의 값을 참조하는 일관된 인터페이스를 제공할 수 있다는 장점을 가집니다.
 
6. 메소드의 이름은 대소문자를 혼용할 수 있지만 반드시 동사를 사용하며 소문자로 시작한다.
getName(), computeTotalWidth()
Java 개발자 커뮤니티에서 사용하는 일반적인 관습이며, Sun 社 가 Java 핵심 패키지에 사용하고 있는 것입니다. 이 방식은 변수의 이름을 지을 때 사용하는 관례와 동일합니다. 하지만, Java 에서는 이미 특별한 양식(getter/setter, 동사로 시작하는 이름, JVM Spec, 등)에 의거하여 메소드는 변수를 구분합니다.
7. 축약형(Abbreviation) 과 두문자어형(頭文字語: Acronym) 을 이름에 사용할 경우에는 전부 대문자로 지정하지 않는다.
exportHtmlSource();    // exportHTMLSource(); 가 아님
openDvdPlayer();       // openDVDPlayer(); 가 아님
축약형 혹은 두문자어형 이름을 모두 대문자로 지정하게 되면 앞서 기술한 명명 지침들과 충돌이 발생하게 됩니다 (대표적으로 상수에 대한 명명 지침과 혼동될 수 있습니다). 그렇다고 이 유형의 이름을 dVD, hTML 등 과 같이 다양한 형태로 지정할 경우에는 가독성이 떨어집니다. 또 다른 문제점으로는 위의 예제에서 살펴볼 수 있는 바와 같이, 이 유형의 이름이 다른 이름과 결합되는 경우 가독성이 극도로 나빠진다는 것입니다. 후속하는 단어가 있을 경우는 더욱 각별히 주의해야 합니다.
8. private 접근 제한자를 갖는 클래스 변수에 '_' 접미사를 사용한다.
class Well
{
  private int  depth_;
  ...
}
변수의 이름이나 타입과는 별개로, 변수의 범위(scope)는 매우 중요한 특성입니다. 접미사 '_' 를 사용함으로써 클래스 범위의 변수(로컬 변수가 아닌)임을 쉽게 구별할 수 있게 됩니다. 클래스 변수는 메소드 내에서 선언되는 로컬 변수에 비해 중요도가 높기 때문에 프로그래머가 각별히 주의해야 합니다. '_' 를 사용하는 명명 규칙은 부가적으로 setter 메소드에서의 이름 충돌문제를 깔끔하게 해결해 줍니다: void setDepth (int depth)
{
  depth_ = depth;
}
제기될 수 있는 이슈거리는 '_' 를 변수의 접두사로 쓸 것인가 접미사로 쓸 것인가에 대한 것입니다. 두 가지 모두 일반적으로 널리 사용되는 방법이기는 합니다만, 이름을 읽기 편하다는 측면에서 후자의 것을 권고합니다. 변수의 이름에 �위를 식별할 수 있도록 하자는 제안은 한 동안 많은 논쟁을 불러일으켰습니다. 그런데 현재에는 이러한 방법이 수용되어 전문 개발자 커뮤니티에서도 일반적인 관례로 점차 정착이 되고 있는 것 같습니다.
 
9. 일반적인 변수의 이름은 타입의 이름과 동일하게 지정한다.
void setTopic (Topic topic)      // void setTopic (Topic value) 이 아님
                                 // void setTopic (Topic aTopic) 이 아님
                                 // void setTopic (Topic x) 이 아님

void connect (Database database) // void connect (Database db) 가 아님
                                 // void connect (Database oracleDB) 가 아님
용어나 이름의 수를 줄이는 것이 코드의 복잡도를 줄여줍니다. 또한 변수의 이름만으로도 그 타입을 손쉽게 유추할 수 있게 해준다는 장점도 있습니다. 만약 어떠한 이유에선가 이러한 관례가 맞지 않는 것처럼 느끼신다면, 이는 분명 타입이름 자체를 잘못 지정한 것입니다. 일반적이지 않은 변수들은 각기 나름의 역할(role)을 가지고 있습니다. 이러한 변수들은 역할과 변수의 타입을 결함하여 이름을 짓곤 합니다. Point startingPoint, centerPoint;
Name  loginName;

 
10. 모든 이름은 영어로 작성한다.
fileName;    // filNavn 나 파일이름 이 아님
국제적인 개발에 있어서 영어가 선호되기 때문입니다.
11. 넓은 범위에 영향을 미치는 변수는 긴 이름을 부여하고, 좁은 범위의 변수는 짧은 이름을 부여한다 [1].
 
임시 저장공간이나 인덱스로 사용되는 Scratch variable (주: 의미있는 값을 갖지 않고 그때그때 상황에 따라 값들을 잠시 보관해 두기 위한 변수로, 대개 보유한 값이 얼마 후에 의미가 없어지거나 삭제됨)들은 매우 짧은 이름을 부여하십시요. 프로그래머가 그러한 변수들을 읽음과 동시에, 이 변수는 몇 라인 뒤에 그 값이 유효하지 않을 것임을 짐장할 수 있게 해야 합니다. 보편적인 scratch variable 로는 정수를 저장하는 i, j, k, m, n 가 있고 문자를 저장하는 c, d 가 있습니다.
12. 호출하려는 객체의 이름을 통해 의미를 짐작할 수 있다면, 메소드의 이름을 간략화할 수 있다.
line.getLength();    // line.getLineLength(); 가 아님
클래스 선언 시에는 후자의 것이 자연스럽지만, 사용할 때에는 위 예에서 볼 수 있듯이 중언부언하는 느낌을 줄 수 있습니다.

3.2 특수한 명명 관례

13. get/set 이라는 용어는 반드시 애트리뷰트에 직접 접근하는 메소드에 사용한다.
employee.getName();
matrix.getElement (2, 4);
employee.setName (name);
matrix.setElement (2, 4, value);
이 접근 메소드 명명 관례는 Java 핵심 패키지들의 명명에 Sun 社 가 사용하고 있는 것입니다. 실제 자바빈즈를 작성할 때에는 이 명명규칙을 준수해야 합니다.
14. is 접두사를 불리언 변수와 메소드에 사용한다.
isSet, isVisible, isFinished, isFound, isOpen
이 불리언 메소드와 변수에 대한 명명 관례는 Java 핵심 패키지들의 명명에 Sun 社 가 사용하고 있는 것입니다. 실제 자바빈즈를 작성할 때에는 이 명명규칙을 준수해야 합니다. is 접두사를 사용함으로써 일반적으로 statusflag 와 같은 좋지 않은 불리언 이름을 선택하는 문제를 해결할 수 있습니다. isStatusisFlag 는 간결하지만 프로그래머에게 의미를 풍부하게 전달할 수 없다는 점에서 바람직하지 못합니다. 일부 상황에서는 is 접두사가 아닌 보다 더 적합한 접두사를 사용할 수도 있습니다. has, can, should 접두사들을 그런 대안으로 활용하실 수 있을 것입니다: boolean hasLicense();
boolean canEvaluate();
boolean shouldAbort = false;

 
15. compute 라는 용어는 무엇인가를 계산(시간이 소요되는)하는 메소드에 사용할 수 있다.
valueSet.computeAverage();  matrix.computeInverse()
프로그래머로 하여금 보는 즉시 이 메소드는 잠재적으로 시간이 소요되는 작업을 수행하고 있다는 것을 주지심으로써, 이 메소드의 결과를 반복해서 사용하고자 할 경우에 프로그래머는 계산된 값을 캐시해 둘 것을 고려하게 만들 수 있습니다. 용어를 일관성있게 사용하는 것은 가독성을 높이는 지름길입니다.
16. find 라는 용어는 무엇인가를 찾는 메소드에 사용할 수 있다.
vertex.findNearestVertex();   matrix.findMinElement(); 
프로그래머로 하여금 보는 즉시 이 메소드는 최소한의 계산을 통해 요청하는 결과를 찾을 수 있는 메소드라는 것을 알려주십시오. 용어를 일관성있게 사용하는 것은 가독성을 높이는 지름길입니다.
17. initialize 라는 용어는 객체나 개념이 확립되어지는 곳에 사용할 수 있다.
printer.initializeFontSet();
미국식 initialize 가 영국식 initialise 보다 바람직합니다. init 라는 축약형 이름은 절대로 사용하지 마십시오.
18. JFC (Java Swing) 변수들은 각 컴포넌트의 타입을 접두사로 사용한다.
widthScale, nameTextField, leftScrollbar, mainPanel, fileToggle, minLabel, printerDialog
변수의 이름 자체가 자신이 어떤 타입의 변수인지 알려주기 때문에 객체가 어떤 자원인지 쉽게 알 수 있습니다.
19. 컬렉션의 이름은 반드시 복수형으로 사용한다.
vertex (one vertex),   vertices(a collection of vertices)
account (one account),    accounts(a collection of accounts)
 
여기서의 컬렉션은 java.util.Collection 변수와 단순 배열과 같은 Collection 의 자손들을 의미합니다.
20. n 접두사는 객체의 개수를 나타내는 변수에 사용한다.
nPoints, nLines
이 표기법은 개체의 개수를 나타내는 수식의 표기법에서 차용한 것입니다. Sun 社 는 Java 핵심 패키지에서 이런 용도로 num 접두사를 사용한다는 것에 주목해 보겠습니다. 이는 필경 number of 에 대한 축약어를 의미할 것입니다만, 그 보다는 number 를 연상시킴으로써 변수 이름을 이상하게 만들거나 혼동을 불러일으킬 수 있습니다. 만약 "number of" 를 더 선호하신다면, n 대신에 numberOf 접두사를 사용하실 수도 있을겁니다. num 접두사는 사용하시지 않기를 강력하게 권합니다.
 
21. No 접미사는 엔터티 번호를 나타내는 변수에 사용한다.
tableNo, employeeNo
이 표기법은 엔터티의 번호를 나타내는 수식의 표기법에서 차용한 것입니다. 또 다른 우아한 표기 방법으로는 i 을 접두사로 사용하는 것입니다: iTable, iEmployee. 이 방법은 효과적으로 변수에 iterator 로의 역할을 부여하게 됩니다.
 
22. Iterator 변수들은 i, j, k 등 과 같은 이름을 사용한다.
while (Iterator i = pointList.iterator(); i.hasNext(); ) {
  :
}

for (int i = 0; i < nTables; i++) {
  :
}
 
이 표기법은 iterator 를 나타내는 수식의 표기법에서 차용한 것입니다. j, k 등과 같은 이름의 변수들은 중첩된 반복문 내에서만 사용합니다.
 
23. 대응하는 단어가 있는 이름은 반드시 함께 사용한다 [1].
get/set, add/remove, create/destroy, start/stop, insert/delete, increment/decrement, old/new, begin/end, first/last, up/down, min/max, next/previous, old/new, open/close, show/hide
대칭을 이루도록 함으로써 복잡도를 줄일 수 있습니다.
24. 축약형 이름의 사용은 피한다.
computeAverage();     // compAvg(); 가 아님
고려해 볼 두 종류의 단어들이 있습니다. 먼저 프로그래밍 언어를 구사하는 데에 있어 빈번하게 사용되는 일반적인 단어들이 있습니다. 이들 단어는 절대로 축약형을 사용하지 말아야 합니다: command    대신 cmd
copy      
대신 cp
point     
대신 pt
compute   
대신 comp
initialize
대신 init
등등.
그 다음, 도메인에서 사용하는 특수한 두문자어나 축약어들은 축약형을 그대로 사용합니다. 이들 구문은 굳이 풀어 나열하지 않고 축약형을 사용하십시오. 다음과 같이 사용하시면 안됩니다: html 대신 HypertextMarkupLanguage
cpu 
대신 CentralProcessingUnit
pe  
대신 PriceEarningRatio
등등.
 
25. 불리언 변수 이름은 절대로 부정적인(거짓인) 이름을 사용하지 않는다.
boolean isError;    // isNotError 가 아님
boolean isFound;    // isNotFound 가 아님
문제는 불리언 변수에 부정적인 이름을 사용할 경우, not 연산자를 사용할 경우 부정의 부정을 계산해야 하는 혼동을 초래한다는 것입니다. 예를 들어, !isNotError 에서 처럼, 신속하게 이것이 무엇을 의미하는지 인지할 수 없게 됩니다.
26. 관련있는 상수(final 변수)들은 공통 타입의 이름을 접두사로 사용하여 그룹핑한다.
final int COLOR_RED   = 1;
final int COLOR_GREEN = 2;
final int COLOR_BLUE  = 3;

final int MOOD_HAPPY  = 1;
final int MOOD_BLUE   = 2;
 
이 표기방법은 상수들이 어디에 속해있는지 상수가 무엇을 나타내고 있는지 식별하는데 도움이 됩니다.
27. 예외(Exception) 클래스들은 Exception 이라는 접미사를 사용한다.
class AccessException
{
  :
}
 
사실 예외 클래스들은 프로그램의 핵심 디자인에 해당되지 않기 때문에, 이와 같은 방식으로 이름을 지정함으로써 상대적으로 클래스들 중에서 눈에 띄게(구분을 용이하게) 해두는 것이 좋습니다. 이 명명 관례는 Java 기본 라이브러리들에 Sun 社 가 사용하고 있는 표준입니다.
28. 디폴트 인터페이스 구현은 Default 라는 접두사를 사용할 수 있다.
class DefaultTableCellRenderer
implements TableCellRenderer
{
  :
}
 
이 방법은 인터페이스 메소드들에 대한 디폴트 처리작업을 제공하는 구현물에, 간단하게 이름을 부여하는 방법으로 널리 사용되고 있는 방법입니다. Default 접두사를 클래스의 이름에 부여하는 이 명명 관례는, Java 기본 라이브러리들에 Sun 社 가 채택한 방식입니다.
29. 함수(객체/결과를 리턴하는 메소드)의 이름은 '처리 후 무엇을 리턴하는지'를 의미하고, 프로시저(void 메소드)의 이름은 '무엇을 처리하는지'를 의미한다.
 
메소드가 무엇을 하는지. 의도하지 않는 것들이 무엇인지를 명확하게 해주기 때문에, 가독성을 높여줍니다. 또한 이 방법은 예기치 못한 부작용(side effect)들로부터 코드를 명쾌하게 유지시켜 줄 수 있습니다.

4 파일

30. Java 소스 파일의 확장자는 .java 이다.
Point.java
Java 개발툴에 의해 강제적으로 준수해야 하는 규칙입니다.
31. 클래스는 각각의 파일에 선언하며, 클래스의 이름과 파일의 이름이 동일해야 한다. 이너(inner) 클래스나 private 으로 선언된 secondary 클래스들은 굳이 별도의 파일로 구분하지 않고도 primary 클래스와 같은 파일 내에서 선언할 수 있다.
 
Java 개발툴에 의해 강제적으로 준수해야 하는 규칙입니다.
32. 파일의 내용물은 반드시 80 컬럼을 벗어나지 않는다.
 
80 컬럼은 다양한 편집기, 프린터, 터미널 에뮬레이터, 디버거에서도 일반적인 길이로, 각 라인이 80 컬럼을 넘지 않도록 소스코드를 작성한다면 다양한 환경의 여러 개발자들과 파일을 공유해서 사용할 수 있습니다. 이는 프로그래머들 간에 파일을 전달하였을 때 의도하지 않은 들여쓰기나 개행문자가 포함되어 가독성이 떨어지는 것을 예방합니다.
33. 탭(TAB) 문자나 페이지 구분(page break) 문자와 같은 특수한 문자들은 절대로 사용하지 않는다.
 
이러한 문자들은 프로그래머가 여럿이거나 다수의 플랫폼에서 개발하는 환경에서, 편집기 별, 프린터 별, 터미널 에뮬레이터 별, 디버거 별로 지정된 설정에 따라 소스코드를 들쭉날쭉하게 만들어 가독성을 떨어뜨리게 됩니다.
34. 여러 라인으로 분리한 문장들은 반드시 명확하게 만든다 [1].
totalSum = a + b + c +
           d + e);
function (param1, param2,
          param3);
setText ("Long line split" +
         "into two parts.");
for (tableNo = 0; tableNo < nTables;  
     tableNo += tableStep)
한 문장이 80 컬럼을 벗어날 때 라인을 분리해서 작성하게 됩니다. 어떻게 라인을 분리해야 하는지에 대한 엄격한 규칙을 제시하기는 어렵습니다만, 위 예제들은 일반적인 힌트를 제공해줄 것입니다: 일반적으로:
  • 콤마(,) 뒤에서 분리한다.
  • 연산자 뒤에서 분리한다.
  • 이전 라인에서의 표현식 시작 부분에 맞추어 정렬한다.

5 문장

5.1 package 와 import

35. package 문은 반드시 파일의 첫번째 라인에 나타나야 하며, 모든 파일은 특정 패키지에 소속된다.
 
package 문의 위치는 Java 언어 코딩 표준에서 권고하고 있는 것입니다. 모든 파일들을 실제 패키지(디폴트 패키지보다는 이름이 있는 패키지)에 두는 것은 Java 객체 지향 프로그래밍 기법에 도움을 줍니다.
36. import 문은 반드시 package 문 뒤에 나와야 한다. import 문은 가장 기본이 되는 패키지들 부터 순차적으로 정렬하며, 관련있는 패키지들은 함께 묶어 두고 빈 라인을 삽입하여 일목요연하게 정리한다.
import java.io.*;
import java.net.*;

import java.rmi.*
import java.rmi.server.*;

import javax.swing.*;
import javax.swing.event.*;

import org.linux.apache.server.*;
 
import 문의 위치는 Java 언어 코딩 표준에서 권고하고 있는 것입니다. 많은 import 문들을 정렬해두면 편리하게 import 문들을 검토할 수 있고, 이를 통하여 현재 이 패키지가 어떤 용도로 설계되었는지를 쉽게 파악할 수 있습니다. 또한 import 문을 그룹핑하면 관련된 정보들을 공통의 유닛으로 관리할 수 있기 때문에 복잡도를 줄일 수 있습니다.
37. import 문을 사용할 때에는 와일드 카드 문자(*)를 사용하지 않는다.
import java.io.*;

대신:

import java.io.File;
import java.io.FileWriter;
import java.io.BufferedWriter;
import java.io.PrintWriter;
import java.io.FileNotFoundException;
 
사실 #36 의 예제와 같이 import 문에 와일드 카드 문자인 * 를 사용하는 것은, 프로그래머에게는 편리할지 모르지만 성능에 얼마간 영향을 미치게 됩니다. 더구나 import 문만 보고도 정확하게 현재 클래스/인터페이스가 어떤 작업을 할 것인지 예측할 수 있도록 하려면, 명시적으로 사용하는 클래스와 인터페이스들에 대해서만 import 하시는 것이 필요합니다.

5.2 클래스와 인터페이스

38. Class 와 Interface 의 선언은 다음과 같은 방식으로 조직화하여 사용한다:
  1. Class/Interface 문서(javadoc 주석)
  2. classinterface 선언문
  3. 클래스 변수(static으로 선언된) 들을 public, protected, package (접근제한자가 없는), private 순서대로 나열한다.
  4. 인스턴스 변수들을 public, protected, package (접근제한자가 없는), private 순서대로 나열한다.
  5. 생성자.
  6. 메소드 (메소드에는 특별한 순서가 없음).
 
각각의 클래스/인터페이스 구성요소들의 등장 위치를 지키게되면, 현재 코드 상에 어떤 요소들이 다음에 등장할 것인지 예측할 수 있게되어 복잡도를 낮추게 됩니다.

5.3 메소드

39. 메소드 지시자는 다음의 순서대로 사용한다:
<access> static abstract synchronized <unusual> final native
만약 <access> 지시자가 존재한다면 반드시 맨 처음에 나타나야 한다.
 
<access> 지시자는 public, protected, private 중 하나이고, <unusual> 부분은 volatiletransient 중 하나가 지정됩니다. 여기서 가장 중요한 점은 접근(access) 지시자가 맨 처음에 나타나야 한다는 것입니다. 사용할 수 있는 다양한 지시자들이 있겠지만, 이는 매우 중요한 사항이기 때문에 반드시 메소드 선언문에 반영되어야 합니다. 기타 지시자들의 순서는 덜 중요하지만 일관된 관례를 따르는 것이 바람직합니다. 여기서 제안한 지시자 나열 순서는 Teach Yourself Java in 21 Days 의 저자인 Charles L. Perkins 씨가 자신의 책에서 제시한 방식을 차용한 것입니다.

5.4 타입

40. 타입 컨버전(변환)은 반드시 명시적으로 한다. 묵시적인 타입 컨버전(변환)은 절대로 사용하지 않는다.
floatValue = (float) intValue;     // floatValue = intValue; 가 아님
위 예제의 경우, 프로그래머가 서로 다른 두 타입을 사용하였으며 그가 의도적으로 두 타입을 혼합해서 사용하고 있음을 알려줍니다. 만약 묵시적으로 floatValue = intValue 라고 하였다면 의도적으로 그러한 것인지, 타입 컨버전을 깜빡 한 것인지 혼동할 수 있습니다.
41. 배열 지시자([])는 변수의 이름 뒤가 아니라 타입의 이름 뒤에 나온다.
int[] daysOfMonth;      // int daysOfMonth[]; 가 아님
배열은 타입의 한 속성이지 변수의 속성이 아니기 때문입니다. 어떤 이유에서인지 Java 에서는 두 가지 모두 문법적으로 허용하고 있습니다만, 하나로 통일하는 것이 좋겠습니다.

5.5 변수

42. 변수는 선언된 지점에서 초기화하며, 가능한 사용범위를 최소화하여 선언한다.
 
이 규칙은 어느 시점에서든 변수가 유효한 값을 가진다는 것을 보장해줍니다. 종종 선언하는 시점에 변수에 유효한 값을 초기화하는 것이 불가능한 경우가 있습니다만, 그러한 경우에도 초기화하지 않은 상태로 내버려두는 것보다는 임의의 값이라도 사용하여 초기화 해두는 것이 좋습니다.
43. 변수는 절대로 하나 이상의 의미를 가져서는 안된다.
 
무의미한 이름을 부여한 변수(scratch 변수)를 가지고 이값 저값을 할당하여 사용하게 되면, 어느 순간 이 변수가 현재 어떤 의미의 값을 가지고 있는지 모호해지는 경우가 발생합니다. 일관되고 유일한 의미를 부여함으로써 가독성을 향상시키고 더불어 부작용까지 예방할 수 있습니다.
44. static 으로 선언된 클래스 변수들은 절대로 public 으로 선언하지 않는다.
 
public 변수들은 Java 의 정보은닉과 캡슐화 컨셉에 위배됩니다. 대신 변수를 private 으로 선언하시고 이 변수를 접근할 수 있는 메소드를 사용하게 하십시오. 한 가지 예외적인 상황은 클래스가 데이터 구조로만 사용될 때입니다. 이 경우 클래스는 어떠한 행위(메소드)도 갖지 않고 오로지 데이터를 보관하는, 즉 C++ 에서의 struct 와 동일한 형태로 사용됩니다. 이 경우에는 클래스의 인스턴스 변수들을 public 으로 선언할 수도 있습니다 [2].
45. 동일한 타입의 변수 중 관련있는 변수들은 하나의 구문에서 선언할 수 있다.
즉, 관련이 없는 변수들을 같은 라인에서 선언하지 않는다.
float  x, y, z;
float  revenueJanuary, revenueFebrury, revenueMarch;
위의 예제를 여러 라인에 나누어 선언하는 것은 바람직하지 않습니다. 변수들을 그룹핑함으로써 가독성을 높일 수 있기 때문입니다. 그러나 여기서 주의할 점은, 대다수의 경우에서는 이 규칙보다 각각의 변수는 선언 시 초기화 한다는 규칙이 우선적으로 적용되어야 한다는 것입니다.
46. 변수의 생존기간을 가능한 짧게 유지한다.
 
변수에 대한 조작을 작은 범위 내에 국한시킴으로써, 영향과 부작용을 통제하는 것이 용이해집니다.

5.6 반복문

47. 반드시 반복을 제어하는데 사용되는 문장들만 for() 구문 내에 포함시킨다.
sum = 0;                   // NOT:     for (i=0, sum=0; i<100; i++)
for (i=0; i<100; i++)      //            sum += value[i];
  sum += value[i];
관리의 용이성과 가독성을 향상시킬 수 있습니다. 무엇이 반복문을 제어하고 무엇이 반복문 내에서 사용되는지 명쾌하게 하십시오.
48. 반복문에 사용하는 변수는 반복문 직전에 초기화한다.
boolean isDone = false;  // NOT:   boolean  isDone = false;
while (!isDone) {        //         :
  :                      //        while (!isDone) {
}                        //          :
                                   }
 
49. do .... while 문의 사용을 피한다.
 
여기에는 두 가지 이유가 있습니다. 첫번째, 제어문에 사용되는 구문 요소(키워드)들이 분산되어 있어 난잡합니다. do .... while 문을 사용한 모든 문장은 while 문이나 for 문을 사용하여 동일하게 바꾸어 작성할 수 있습니다. 사용되는 구문 요소들을 최소화함으로써 복잡도를 줄일 수 있습니다. 두번째 이유는 가독성과 관련되어 있습니다. 반복의 조건을 체크하는 부분이 하단에 위치하는 것은, 상단에서 조건을 체크하는 반복문보다 읽기가 더욱 어렵습니다.
 
40. 반복문 내에서 breakcontinue 의 사용을 자제한다.
 
이 두 문장은 구조화된 반복문보다 훨씬 가독성이 높을 때에만 사용하십시오. 일반적으로 break 문은 case 문 내에서만 사용하시고, continue 문은 반복문이든 case 문이든 어떤 경우라도 사용을 피해주시기 바랍니다.
 

5.7 조건문

51. 복잡한 조건식은 반드시 피한다. 그 대신 임시 불리언 변수를 활용하라 [1].
if ((elementNo < 0) || (elementNo > maxElement)||
    elementNo == lastElement) {
  :
}
다음과 같이 변경한다: boolean isFinished      = (elementNo < 0) || (elementNo > maxElement);
boolean isRepeatedEntry = elementNo == lastElement;
if (isFinished || isRepeatedEntry) {
  :
}

 
조건식을 불리언 변수에 할당함으로써, 프로그램 그 자체로 의미를 명확하게 전달하고 있습니다. 조건문을 평가하는 구문은 보다 쉽게 해석할 수 있으며, 더불어 디버깅할 때에도 편리해집니다.
52. if 문에서, 일반적인 상황은 if 블록에 위치시키고 예외 상황은 else 블록에 위치시킨다 [1].
boolean isError = readFile (fileName);
if (!isError) {
  :
}
else {
  :
}
일반적인 처리 흐름과 예외상황 처리 흐름을 불명확하지 않게 하십시오. 이 지침은 가독성과 성능 모두에 영향을 미치는 중요한 사항입니다.
53. 조건을 평가하는 문장은 별도의 라인으로 분리한다.
if (isDone)              // NOT:  if (isDone) doCleanup();
  doCleanup();
이는 디버깅을 위한 목적으로 한 것입니다. 한 라인에 이것저것 기술하게 되면, 조건식 테스트가 참인지 거짓인지를 확인하기가 어려워집니다.
54. 절대로 조건식에 실행문을 사용하지 않는다.
file = openFile (fileName, "w");  // NOT:   if ((file = openFile (fileName, "w")) != null) {
if (file != null) {               //         :
  :                               //        }
}
조건식에 실행문을 사용하는 것은 간편하지만 읽기가 매우 어려워집니다. 이 지침은 Java 에 발을 처음으로 들여놓는 개발자들에게 특히 강조하고 싶은 지침입니다.

5.8 기타

55. 코드 상에서 매직 넘버(magic number: constants, array size, character positions, conversion factors와 같이 프로그램내에 등장하는 숫자/문자값)의 사용을 자제한다. 01 이외의 숫자는 차라리 상수로 정의하여 사용하도록 한다.
 
명확한 의미를 갖지 않는 숫자를 사용할 경우, 가독성 향상을 위하여 상수로 정의하여 사용하도록 합니다.
56. 실수값 상수는 항상 소수점과 최소한 소숫점 이하 한 자리 숫자를 사용하여 지정한다.
double total = 0.0;   // double total = 0; 가 아님
double speed = 3.0e8; // double speed = 3e8; 가 아님

double sum;
:
sum = (a + b) * 10.0;
특별한 경우에 정수와 실수가 동일한 값을 갖는다 하더라도 기본적으로 특성이 다르기 때문에 구별하는 것이 좋습니다. 또한 위 마지막 라인의 예제에서 살펴볼 수 있듯이, 값을 할당받은 변수(sum)는 다른 변수의 타입을 알 수 없다고 하더라도 명백하게 실수값을 계산해 낸다는 것을 보장할 수 있습니다 (* 10.0 을 통해서)
 
57. 실수값 상수는 항상 정수부에 숫자를 사용하여 지정한다.
double total = 0.5;   // double total = .5; 가 아님
Java 에서 사용하는 숫자와 표현식은 수학식 표기법에서 차용하였으므로, 프로그래머는 가능한 수학적 표기법을 준수하는 것이 바람직합니다. 실제로 .5 (간편한 표기) 보다 0.5 (수학적 표기) 가 더 읽기에 쉽습니다. 이 수식에서 정수 5 가 함께 사용되는 경우에는, .5 와 정수 5 를 혼동하여 잘못된 연산을 초래할 가능성이 높아지게 됩니다.

6 레이아웃과 주석

6.1 레이아웃

58. 기본 들여쓰기(indentation)는 4 자로 한다.
for (i = 0; i < nElements; i++)
  a[i] = 0;
1 자짜리 들여쓰기는 너무 작아서 논리적인 코드의 레이아웃에 사용합니다. 한편 4 자 이상 들여쓰기를 할 경우 중첩 들여쓰기한 코드를 읽기가 어려워지며, 한 문장을 여러 라인으로 쪼개야하는 상황이 자주 발생하게 됩니다. 2, 3, 4 글자 중에서 선택하시는 것이 바람직합니다만, 2 자와 4자가 가장 보편적입니다. 2 자로 하였을 경우에는 한 문장을 여러 라인으로 쪼개야할 상황을 최소화할 수 있습니다. Sun 社 에서는 4 자 들여쓰기를 권고하고 있습니다. 이 지침은 본래 2 자였던 것을 Sun 표준인 4 자로 변경한 것입니다.
59. 블록 레이아웃은 아래 예제 1 (권고안) 나 예제 2 를 따르되, 예제 3 의 형태는 결코 취해서는 안된다. 클래스, 인터페이스, 메소드 블록은 예제 2 레이아웃을 따른다.
while (!isDone) {
  doSomething();
  isDone = moreToDo();
}
 
while (!isDone)
{
  doSomething();
  isDone = moreToDo();
}
 
while (!isDone)
  {
    doSomething();
    isDone = moreToDo();
  }
 
예제 3은 추가적인 들여쓰기를 사용하고 있으나 예제 1 와 예제 2 를 사용한 것보다 나을 것이 없습니다.
60. classinterface 선언문은 다음과 같은 형태를 따른다:
class SomeClass extends AnotherClass
  implements SomeInterface, AnotherInterface
{
  ...
}
 
이 지침은 위에서 언급한 #59 의 일반적인 블록 규칙에 의거한 것입니다. Java 개발자 커뮤니티에서는 클래스를 선언하는 문장의 끝에서 중괄호를 여는 것이 일반적입니다. 실제로 이 괄호 스타일은 모든 종류의 블록에 대하여 사용할 수 있는 방식입니다. 개인적인 선호의 차이가 있겠지만, 이 방식은 C/C++ 에서 클래스와 메소드 블록은 다른 블록들과 구분할 수 있도록 하는 것을 차용한 것입니다.
61. 메소드 선언문은 다음과 같은 형태를 따른다:
public void someMethod()
  throws SomeException
{
  ...
}
 
class 문장에 대한 설명을 참고하십시오 (#59).
62. if-else 문장은 다음과 같은 형태를 따른다:
if (condition) {
  statements;
}

if (condition) {
  statements;
}
else {
  statements;
}

if (condition) {
  statements;
}
else if (condition) {
  statements;
}
else {
  statements;
}
 
이 지침은 위에서 언급한 #59 일반적인 블록 규칙에 의거한 것입니다. 하지만, else 절이 직전의 ifelse 절의 닫히는 중괄호와 동일한 라인에 있어야 한다고 한다면 논의를 해 볼 수도 있을 것입니다:

if (condition) {
  statements;
} else {
  statements;
}

이 방식은 Sun 社의 코딩 표준 권고안에서 제시한 것과 동일한 것입니다. 여기서 제시한 방법은 if-else 문장을 별도의 행에 분리되어 있기 때문에, else 절을 쉽게 식별할 수 있고 (직전 ifelse 절의 닫히는 중괄호 때문에 else 절이 잘 드러나지 않는 경우도 있습니다) 심지어 else 절을 이동한다거나 하는 경우에 손쉽게 if-else 문장을 조작할 수 있다는 점에서 조금 더 낫다고 할 수 있겠습니다.
63. A for 문장은 다음과 같은 형태를 따른다:
for (initialization; condition; update) {
  statements;
}
 
이 지침은 위에서 언급한 #59 일반적인 블록 규칙에 의거한 것입니다.
64. 비어있는 for 문장은 다음과 같은 형태를 따른다:
for (initialization; condition; update)
  ;
이 방식은 프로그래머가 의도적으로 for 문장을 비워두었음을 분명히할 수 있습니다.
65. while 문장은 다음과 같은 형태를 따른다:
while (condition) {
  statements;
}
 
이 지침은 위에서 언급한 #59 일반적인 블록 규칙에 의거한 것입니다.
66. do-while 문장은 다음과 같은 형태를 따른다:
do {
  statements;
} while (condition);
 
이 지침은 위에서 언급한 #59 일반적인 블록 규칙에 의거한 것입니다.
67. switch 문장은 다음과 같은 형태를 따른다:
switch (condition) {
  case ABC :
    statements;
    // Fallthrough 혹은 '계속'
  case DEF :
    statements;
    break;
  case XYZ :
    statements;
    break;
  default :
    statements;
    break;
}
 
이 방식은 Sun 社의 코딩 표준 권고안과는 들여쓰기와 공백문자 처리에 있어서 약간 다릅니다. 특히, 각각의 case 키워드들은 모두 switch 문에 소속되어 있음을 부각시키기 위하여 switch 키워드를 기점으로 들여쓰기를 수행하였습니다. 이로써 switch 문이 강조되었습니다. 한 가지 더 주목해서 보셔야 할 것은 casedefault 키워드들과 : 문자 사이에 추가 공백이 들어있다는 점입니다. break 문을 사용하지 않는 case 문에는 반드시 명시적으로 Fallthrough계속 이라는 주석을 달아주십시오. break 문을 빠뜨리는 것은 일반적인 실수이기 때문에, 이와 같은 주석을 명시함으로써 실수가 아니라 의도적으로 break 문을 생략했다는 것을 분명히 할 수 있습니다.
2004-04-14 08:43:56.0 (wgshim 222.108.45.193) D
68. try-catch 문장은 다음과 같은 형태를 따른다:
try {
  statements;
}
catch (Exception exception) {
  statements;
}

try {
  statements;
}
catch (Exception exception) {
  statements;
}
finally {
  statements;
}
 
이 지침은 위에서 언급한 #59 일반적인 블록 규칙에 의거한 것입니다. 이 형태 역시 #61 의 if-else 문이 그랬던 것처럼, Sun 社의 코딩 표준 권고안에서 제시한 것과는 다릅니다. #61 을 참고하시기 바랍니다.
69. 단일 문장의 if-else, for, while 문은 중괄호 없이 작성할 수도 있다.
if (condition)
  statement;

while (condition)
  statement;

for (initialization; condition; update)
  statement;

 
일반적인 코딩 권고안은 Sun 社의 Java 코딩 표준 권고안에도 포함되어 있는 것과 같이, 모든 경우에 항상 중괄호를 사용하여 블록화 하라는 것입니다. 하지만 블록은 여러 문장을 그룹핑하기 위한 용도로 사용되기 때문에, 단일 문장을 묶는 것은 오히려 번거로울 수 있습니다. #52 와 같이 조건을 평가하는 부분과 실행문을 분리해서 기록하며 들여쓰기를 제대로 한다면 크게 문제되지는 않습니다.

6.2 공백문자

70.
- . 를 제외한 모든 binary 연산자(conventional operator)는 피연산자들 사이에 스페이스로 분리한다.
   예외적으로 Unary operator(++, --) 와 피연산자 사이에는 공백을 두지 않는다.
- Java 예약어/키워드 뒤에 공백문자 하나를 추가한다.
- 콤마(,) 뒤에 공백문자 하나를 추가한다.
- 콜론(:) 의 앞뒤에는 공백문자를 추가한다.
- for 문 내의 세미콜론(;) 문자 뒤에 공백문자 하나를 추가한다.
a = (b + c) * d;            // NOT:   a=(b+c)*d
while (true) {              // NOT:   while(true) ...
doSomething (a, b, c, d);   // NOT:   doSomething (a,b,c,d);
case 100 :                  // NOT:   case 100:
for (i = 0; i < 10; i++) {  // NOT:   for (i=0;i<10;i++){
이 방법은 문장의 각 구성요소들을 부각시켜 가독성을 높여줍니다. 여기서 제안하는 Java 코드 상에서의 공백문자 사용에 관한 모든 예제를 다 나열하기는 어렵겠습니다만, 위에 제시한 예제로도 충분히 그 의도를 제시해주고 있습니다.
71. 메소드의 이름과 메소드의 여는 괄호 사이에 공백문자를 사용하지 않는다.
(참고: 본래 이 문서의 원본에는 Sun 社의 권고안과는 달리 '메소드의 이름과 여는 괄호 사이에도 공백문자를 넣어 모든 이름을 부각시키자' 라고 언급하고 있었으나 변경함)
doSomething(currentFile);    // doSomething (currentFile); 가 아님
#69 지침에 의해 Java 의 예약어/키워드 뒤에 공백문자를 추가하기 때문에, 메소드의 이름과 여는 괄호 사이에 공백을 없앰으로써 메소드 호출과 키워드를 구별하는데 도움을 줍니다.
72. 블록 내의 논리적인 유닛들은 빈 라인을 하나 삽입하여 구분한다.
 
블록 내 논리적 유닛들 사이에 공백을 삽입함으로써 가독성을 향상시키게 됩니다.
73. 메소드 선언들 간에는 3-5 개의 빈 라인을 삽입하여 구분한다.
 
메소드 내에서 사용하는 빈 라인보다 많은 라인을 삽입함으로써 클래스 내 각각의 메소드들을 부각시키게 됩니다.
74. 선언문에서의 변수는 타입과 구분하여 변수끼리 좌측정렬 한다.
AsciiFile  file;
int        nPoints;
float      x, y;
타입과 변수를 구분하여 정렬함으로써 변수를 부각시켜 가독성을 높이게 됩니다.
75. 문장은 가독성을 높이기 위하여 정렬한다
if      (a == lowValue)    compueSomething();
else if (a == mediumValue) computeSomethingElse();
else if (a == highValue)   computeSomethingElseYet();


value = (potential        * oilDensity)   / constant1 +
        (depth            * waterDensity) / constant2 +
        (zCoordinateValue * gasDensity)   / constant3;


minPosition     = computeDistance (min,     x, y, z);
averagePosition = computeDistance (average, x, y, z);


switch (value) {
  case PHASE_OIL   : phaseString = "Oil";   break;
  case PHASE_WATER : phaseString = "Water"; break;
  case PHASE_GAS   : phaseString = "Gas";   break;
}
일반적인 지침에 위배될 수도 있겠지만 위 예제에서는 가독성을 높이기 위하여 코드 사이에 공백문자를 넣었습니다. 공백문자를 넣을 때에는 코드의 정렬방식을 준수합니다. 번거로울 수 있겠지만 코드를 정렬함으로써 코드를 한 눈에 들어오게 만들 수 있습니다. 이렇게 공백문자를 넣어 정렬하는 코드정렬에 대해 일반적인 지침을 제시하기는 어렵겠습니다만, 위에 제시한 예제로도 충분히 그 의도를 제시해주고 있습니다.

6.3 주석

76. 난잡한 코드에는 주석을 다는 것보다는, 코드를 구조화하여 재작성하고 명료한 코드에 주석을 다는 것이 낫다 [1] .
 
일반적으로 적절한 이름 선정과 명쾌한 논리 구조를 바탕으로, 코드 자체만으로도 충분히 이해가 되도록 작성하는 것이 우선이고 그 후 주석을 다는 것이 바람직합니다. 주석을 달지 않는 프로그래머를 나쁜 습관을 가졌다고 하지만, 역설적으로 코딩을 정말 잘하는 프로그래머는 주석을 많이 달 필요가 없는 것입니다.
77. 모든 주석은 영어로 작성한다.
 
국제적인 제품을 개발하고자 할 때에는, 주석도 자국어를 사용하는 것 보다는 영어를 사용하는 것이 바람직합니다.
78. JavaDoc 주석이 아닌 모든 주석과 여러 줄을 사용하는 주석에 // 를 사용한다.
// 한 줄 이상의
// 주석이랍니다

// /*
   여러 라인의 주석을 해제합니다.
// */
Java 에서 멀티 레벨 주석을 지원하지 않기 때문에, 디버깅이나 기타 목적으로 사용한 /* */ 블럭의 주석을 해제하는데 // 를 사용하기도 합니다.
79. 주석은 설명하려는 코드와 같은 위치에서 들여쓰기하여 작성한다 [1].
while (true) {          // NOT:    while (true) {
  // Do something       //         // Do something
  something();          //             something();
}                       //         }
이 방법은 주석이 프로그램의 논리적인 구조를 깨뜨리지 않게 해줍니다.
80. collection 변수를 선언할 때에는, 컬렉션에 담겨질 요소들의 공통 타입에 대한 주석을 작성한다.
private Vector  pointList_;  // Point 객체에 대한 Vector
private Set     shapeSet_;   // Shape 객체에 대한 Set
 
이러한 추가적인 주석이 없다면 컬렉션이 어떤 요소들로 구성되어 있는지 파악하기가 어려워지기 때문에, 컬렉션의 요소들을 어떻게 다뤄야 하는지 혼동이 되는 경우가 발생합니다. 컬렉션 변수를 입력 인자로 받아들이는 메소드에서는, JavaDoc 주석을 사용하여 컬렉션 입력 인자의 요소들의 공통 타입을 기술하십시요.
81. 모든 public 클래스와 public 클래스의 public, protected 로 선언된 메소드들에 JavaDoc 방식의 주석을 작성한다.
 
이 방식은 간편하게 온라인 코드 API 문서를 항상 최신내용으로 유지시킬 수 있도록 합니다.
82. 각 파일에는 package 선언문 상단에 다음과 같은 헤더를 삽입한다:
/*
 * (@)# <<파일의 이름>>.java
 *
 * $Header$
 * $Revision$
 * $Date$
 *
 * ====================================================================
 *
 * <<회사 이름>>., Software License, Version 1.0
 *
 * Copyright (c) 2002-2004 <<회사 이름>>.,
 * <<회사 주소>>  * All rights reserved.
 *
 * DON'T COPY OR REDISTRIBUTE THIS SOURCE CODE WITHOUT PERMISSION.
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <<회사 이름>> OR ITS
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * For more information on this product, please see
 * <<회사 웹 사이트 URL 주소>>
 *
 */
각 파일의 상단에 코드의 소유자(혹은 조직)와 라이센스 및 책임의 한계에 대한 정보를 기술합니다.
83. class, interface 및 메소드 선언문 위에는 다음과 같은 JavaDoc 주석을 삽입한다:
/**
 * 클래스, 인터페이스 메소드에 대한 설명을 기술합니다.
 *
 *   메소드의 경우는 다음 항목들을 기록하십시오:
 *      - 메소드의 작성의도
 *      - 메소드를 사용하기 위한 사전조건(pre condition) 과 사후조건(post condition)
 *      - 부작용
 *      - 종속성 (종속되는 라이브러리, 클래스, 메소드 등)
 *      - 사용시 주의해야 할 점
 *      - 누가 이 메소드를 호출하는가
 *      - 언제 이 메소드를 재정의해야 하는가
 *      - 메소드 재정의 시 어디서 부모 메소드를 호출해야 하는가(super 키워드를 사용하여)
 *      - 제어 흐름 및 상태 전이에 관련된 내용들
 *
 * @author (클래스와 인터페이스에서만 사용합니다)
 * @version (클래스와 인터페이스에서만 사용합니다)
 *
 * @param (메소드와 생성자에서만 사용합니다)
 * @return (메소드에서만 사용합니다)
 * @exception (Javadoc 1.2 의 @throws 와 같은 표현입니다)
 * @see
 * @since
 * @serial (또는 @serialField 나 @serialData)
 * @deprecated (deprecated 된 클래스, 인터페이스, 메소드에 대해 어떻게 대응해야 하는지 기록합니다)
 */

public class Example { ...
 
JavaDoc에 대한 자세한 최신 정보는 이곳을 참고하시기 바랍니다.

7 참고문헌

[1] Steve McConnel, "Code Complete," Microsoft Press. [2] Sun, "Java Code Conventions," http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html [3] Netscape, "Software Coding Standards for Java," http://developer.netscape.com/docs/technote/java/codestyle.html [4] NASA, "C / C++ / Java Coding Standards," http://v2ma09.gsfc.nasa.gov/coding_standards.html [5] AmbySoft, "Coding Standards for Java," http://www.ambysoft.com/javaCodingStandards.html

 


www.jlab.net
 

이 컨텐츠는 JPL에 의해서 보호 받습니다. 오탈 자나 건의는 이곳에 해주십시오
이 컨텐츠는 © 2004 Geotechnical Software Services. 에서 제공하는 Geosoft 의 Java Programming Style Guidelines 문서를 번역 및 수정한 것임을 밝힙니다.

"+tagNames[i]+""; editTagStr += tagNames[i]; if(i != tagNames.length-1) { tagStr += ", "; editTagStr += ","; } } tagElem.innerHTML = tagStr; tagElem.style.display = "inline"; }catch(e) {} resizeIfr(parent.document.getElementById('papermain'),300); } function setTagTopList(logno, tagList) { try { var tagNames = tagList.split(","); var editTagStr =""; var tagElem = $('tagTopName_'+logno); var tagStr = ""; for(var i =0; i < tagNames.length; i++) { tagStr += ""+tagNames[i]+""; editTagStr += tagNames[i]; if(i != tagNames.length-1) { tagStr += ", "; editTagStr += ","; } } tagElem.innerHTML = tagStr; tagElem.style.display = "block"; }catch(e) {} } function highlightMyTag() { return; } function showTagEditBox(logno) { try{ var tagElem = $('tagName_'+logno); tagElem.style.display = "none"; var tagEditElem = $('edit_tagName_'+logno); tagEditElem.style.display = "block"; }catch(e){} } function hideTagEditBox(logno) { try{ var tagElem = $('tagName_'+logno); tagElem.style.display = "inline"; var tagEditElem = $('edit_tagName_'+logno); tagEditElem.style.display = "none"; }catch(e){} } function loadTagInfo () { loadData("/BlogTagListInfo.nhn?blogId=msd102&logNo=150015998795", setTagListinfo); } function goPostView(logNo, postListTopCurrentPage) { var url = "blogId=msd102&logNo=" + logNo + "&categoryNo=0&viewdate=&cpage=1&postListTopCurrentPage=" + postListTopCurrentPage; document.location.href = "http://blog.naver.com/PostView.nhn?" + url; } function goPostViewBottom(logNo, postListTopCurrentPage) { var url = "from=search&blogId=msd102&logNo=" + logNo + "&categoryNo=0&viewdate=&cpage=1&postListTopCurrentPage=" + postListTopCurrentPage; document.location.href = "http://blog.naver.com/PostView.nhn?" + url; } // Post 리스트의 페이지 이동 function goPageList(page) { var url = "blogId=msd102&postListTopCurrentPage=" + page + "&categoryNo=0&viewdate="; $('postTop').src = "http://blog.naver.com/PostListTop.nhn?" + url; settop(); } // 검색을 통해서 들어올경우 생기는 하단목록인 경우의 해당 카테고리no를 파라메터로 보낸다. -20070503 jina function goBottomPageList(page) { var url = "blogId=msd102&postListTopCurrentPage=" + page + "&categoryNo=32&viewdate=&listType=bottom"; $('postBottom').src = "http://blog.naver.com/PostListBottom.nhn?" + url; } function checkRClickYN(isRClickAllowed, isAdmin) { if(isRClickAllowed == 1 && !isAdmin) { document.oncontextmenu = new Function ("return false"); document.ondragstart = new Function ("return false"); document.onselectstart = new Function ("return false"); } } var categoryName = "자바프로그래밍"; :badtag -->
목록열기 전체목록 (588)
자바 소켓 프로그램 예제 자바프로그래밍

2007/03/27 12:24

http://blog.naver.com/msd102/150015998795

자바 소켓 프로그램 예제
2007.02.28 08:45
http://tong.nate.com/rahxephon/34459368
Java Socket Based Network Programming

본 강좌는 자바스터디에서 개제된 realmove 님의 글을 토대로 했습니다.

본 강좌에서는 자바를 이용한 소켓 기반의 네트워크 프로그래밍을 하고자한다. 본 강좌는 스트림의 개념부터 소켓의 정의와 실제 그리고 3개의 프로젝트로 구성된다. 먼저 자바에서의 모든 입출력을 담당하는 Stream에 대한 의미를 살펴보고, 실제 자바에서의 스트림의 관계에 대해 알아본다. 이미 이전 강좌에서 유닉스 소켓에 대한 개념을 살펴보았다는 가정하에 자바에서 이용하는 소켓의 의미를 알아본다. 마지막으로 3개의 프로젝트에서는 클라이언트/서버 모델의 단순 통신 프로그램 , 네트워크 전자계산기, 다중클라이언트처리를 하는 멀티쓰레딩 서버를 구현하여 자바를 이용한 소켓 네트워크 프로그래밍의 전반을 알아보고자 한다.


Stream의 의미


스트림은 연속적인 데이터의 흐름으로 정의할수있다. 실제로 모든 컴퓨터 네트워크 프로그램은 스트림을 사용하여 구동된다. 간단한 예를 살펴보자. 서로 다른 두개의 프로그램이 어떻게 서로 데이터를 주고 받을것인가.  서로 다른 두개의 프로그램은 상대의 모든 구현 함수와 내부 구조를 알고 있어야 하는가.. 이러한 상황에서 서로 다른 프로그램들간의 데이터 전송을 위해서 스트림을 이용할수있다.
스트림은 단순히 자바에서 네트워크 프로그래밍을 다룰때만 사용되는것이 아니다.  자바에서만 지원하는 것이 아니라 OS차원에서 지원을 하는 기능이다.  이말은 스트림 통신을 하기 위한 두 프로그램이 반드시 자바로 작성될 필요는 없다는 것을 의미합니다. 하나는 자바로, 다른 하나는 C로 작성될 수도 있고, 다른 어떤 언어를 사용하는 것도 가능하다는 의미입니다.

사실 윈도우나 유닉스, 리눅스 등의 OS를 설치하여 컴퓨터를 사용하는 사람이라면 누구나 항상 스트림을 사용합니다. 예를 들어 윈도우의 도스창(command prompt) 또는 유닉스 콘솔에서 화면에 글자를 찍는 것이나, 프린터에 프린트를 하는 것이 그렇습니다. 우리는 간단하게 System.out.println("내용..."); 라는 명령으로 화면에 찍습니다. 그러나 실제로 println()메소드에서는 주어진 인자의 값을 적당한 장소에 스트림을 사용하여 쭉 보내주게 되죠. 스트림, 즉 하나의 연속적인 흐름으로 보내는 것입니다. 화면에 출력하기 위해서는 화면출력을 담당하는 위치에 스트림으로 보내면 되고, 프린터에 출력하고 싶다면 프린터출력을 담당하는 위치에 스트림으로 보내면 됩니다. 화일에 저장하는 것, 하니면 채팅프로그램처럼 두 프로그램이 통신을 하는 것, 모두 사실은 그런 메카니즘을 가지고 있습니다. 다음은 UNIX에서 파이프라인이라는 기능 속에서 스트림이 어떻게 사용되는지를 보여주는 예입니다.

UNIX를 사용해본 사람이라면 파이프라인을 알고 있을 것입니다. windows NT의 명령창에서도 지원하는 기능인데, ls는 도스에서 dir과 같은 기능을 하죠?

SHELL> ls | more

와 같이 같이 명령을 내리면 어떻게 될까요? 화일이 많은 경우 ls라고 그냥 하면 읽을 새도 없이 화면이 쭉 스크롤 되죠. 하지만 앞에서와 같이 하면 한 화면 만큼씩만 출력되게 됩니다. 실제로 이 작업은 두 개의 프로그램이 돌고 있는 것입니다. ls라는 프로그램과 more라는 프로그램이죠. 그냥 ls라고 쳤을 경우에는 결과를 화면출력을 담당하는 곳에 스트림으로 보내지만 지금처럼 파이프라인으로 연결하면, ls는 결과를 스트림으로 보내게 되고, 이것을 more호라는 프로그램에서 스트림으로 받아서 화면에 한 페이지씩 보여주게 되는 것입니다. 두 프로그램이 통신을 하는 경우 중의 대표적인 예가 바로 이러한 파이프라인이죠.
좀더 나아가면 파이프라인을 여러 개 사용할 수도 있습니다.

SHELL> ls | grep txt | more

짐작하다시피 이번에는 프로그램이 3개가 돌게 됩니다. ls가 화일의 명령을 뽑아서 스트림으로 보내면, 그것을 grep이라는 명령이 받아서 그중 txt라는 문자열을 포함하는 라인만을 골라서 다시 스트림으로 보냅니다. 마지막으로 more라는 프로그램이 앞에서와 같이 스트림으로 받아서 앞에서와 같이 한 화면씩 출력하게 됩니다.

2. 스트림 입력/ 스트림 출력

스트림에는 사실 여러 종류가 있습니다. byte스트림,문자열스트림,데이터그램스트림 등이 그것입니다. 여기서는 사실 문자열(String)스트림만을 다루려고 합니다. byte스트림과 문자열 스트림은 12라는 정수가 "12"로 가느냐(문자열스트림) 아니면 0C(12)인 숫자(byte스트림)으로 가느냐의 차이가 있을뿐 거의 비슷합니다. 데이터그램 스트림은 약간 다르지만 문자열 스트림을 알고나면 금방이해할 수 있을 것입니다.

앞의 UNIX의 파이프라인 예제를 보고 알아챈 사람도 있을테지만, 스트림은 입력과 출력이 있습니다. 즉 스트림을 보내는 것과 받는 것, 두 가지 동작이 있을 수 있다는 이야기입니다. 프린터에 출력하는 경우, 프로그램에서는 프린터스트림에 보내는(출력) 역할을 할 것이고, 프린터는 그것을 스트림에서 받아서(입력) 인쇄하게 되겠죠. 앞의 파이프라인의 경우, 앞에 있는 프로그램에서 스트림으로 출력을 하면, 뒤에 있는 프로그램에서 그것을 받게 되는 것입니다.

3. Stream의 사용

C와 같은 다른 언어와 마찬가지로 자바에서도 InputStream과 OutputStream을 지원하고 있습니다. 즉 이 클래스들을 입력 또는 출력하고자하는 적당한 객체에 연결시켜준 다음 read나 write 메소드 등을 사용하여 입력과 출력을 하게 되는 것입니다. 만일 키보드로부터 입력을 받아서 화면에 출력하고자하면,

InputStream in=System.in;
OutputStream out=System.out;

와 같이 선언하여, in.read()문으로 내용을 입력 받아서 out.write()메소드를 사용하여 출력할 수 있다는 말입니다. 만약 in과 out이 각각 화일이나, 프린터 등에 연결되어 있다면 물론 화일에서 내용을 읽거나 쓸 수 있고, 프린터에 출력할 수도 있습니다.

하지만 여기에서는 스트림을 사용하는 일반적인 방법에 대해서는 설명하지 않고, 바로 소켓으로 넘어가도록 하겠습니다. 자바에서는 화면에 출력하기 위해서 콘솔(화면)을 사용하는 경우는 거의 없습니다. 하지만 콘솔(키보드)에서 입력받기 위한 경우나, 프린터에 출력하고자하는 경우, 화일의 내용을 읽거나 쓰는 경우에는 반드시 스트림을 사용합니다. 또한 바로 뒤에서 다룰, TCP/IP Protocol을 이용한 인터넷에서의 통신에서도 물론 스트림을 사용합니다.

 


Socket in TCP/IP protocol

1. Socket


여기서부터가 이번 글에서의 본론입니다. 사실 swing이나 awt같은 추상윈도우툴킷을 사용하면 키보드로부터 입력받는 것을 직접 작성할 필요도 없고, 프린터 출력 부분도 사실 남이 작성해 놓은 코드를 복사해서 약간 수정하면 쉽게 할 수 있습니다. 화일 입출력도 스트림을 제대로 설정만 해놓으면 화면에 출력하듯이 간단하게 입력과 출력을 사용할 수 있습니다. 하지만 socket을 이용한 프로그램만은 그렇지가 않습니다. 물론 개념은 스트림을 사용하는 다른 작업들과 크게 다르지 않지만 기술적인 면에 있어서 원하는 기능을 구현하는 것이 그리 쉽지만은 않기 때문입니다.

이제부터 정신을 똑바로 차리세요. 이글에서는 소켓의 구조나 TCP/IP와 같은 일반적인 네트워크 정보에 대해서는 생략하도록 하겠습니다. 미리 알고 있어야 한다는 얘기는 아니고 자세히는 몰라도 된다는 말입니다. 이글에서는 먼저 소켓을 정의해서 스트림을 사용하여 입력과 출력을 받는 것을 간단히 구현하는 프로젝트를 진행해보고, 마지막에 가서는 하나의 서버에 여러 개의 클라이언트가 접속하는 멀티 클라이언트 채팅프로그램을 작성하는 프로젝트를 진행하도록 하겠습니다.

프로젝트1. 서버와 클라이언트

여기서 완성될 프로그램은 다음과 같은 순서로 작동을 하게 됩니다.

  1. 서버가 소켓을 생성하고 연결을 기다린다.
  2. 클라이언트에서 서버의 소켓에 연결한다.
  3. 클라이언트에서 데이터를 전송다.
  4. 서버에서 데이터를 받아서 화면에 출력한다.
  5. 서버와 클라이언트의 소켓 연결을 끊는다.

이 프로젝트에서는 물론 두 개의 프로그램을 작성해야 하겠죠. 서버 쪽과 클라이언트 쪽입니다. 각각 SocketServer.java 와 SocketClient.java 로 하기로 하죠.

 

예제 프로그램: SocketServer.java / SocketClient.java

우선은 위의 예제 프로그램을 다운받아서 실행시켜보기를 바랍니다. 콘솔(윈도우에서는 명령 프롬프트 = 한글 MS-DOS)를 두 개를 띄워야겠죠. 아무 콘솔에서나 두 프로그램을 컴파일 합니다.

SHELL> javac SocketServer.java
SHELL> javac SocketClient.java

컴파일 된 후 실행시킵니다. 하나의 콘솔에서 서버를 먼저 실행시킵니다. 파라미터로 포트값을 주는데, 주지 않으면 5777번이 잡히게 됩니다. 포트번호는 3000번 이상의 값을 주는게 좋습니다.

SHELL> java SocketServer 6000

그러면 포트번호와 클라이언트의 연결을 기다린다는 메시지가 나오게 됩니다. 6000은 포트 번호입니다. 이 값은 생략가능하고 생략하면 5777번 포트를 사용하게 됩니다. 그러면 클라이언트를 실행시킵니다. 파라미터는 IP와 포트번호를 줍니다.

SHELL> java SocketClient 6000 211.35.136.174

포트번호는 물론 앞의 서버에서 설정한 포트번호와 같아야 하겠죠. IP는 자신의 컴퓨터 아이피를 주면 됩니다. IP를 주지 않으면 127.0.0.1에 연결하는데, 보통 이 번호는 로컬 호스트, 즉 자기 자신을 의미합니다. 만약 이 번호로 되지 않거나 다른 컴퓨터에서 SocketServer를 실행시켰다면 IP를 반드시 써주어야 하겠죠. 아무튼 서버와 포트 번호가 일치하고 IP를 적당히 주었다면 클라이언트는 서버에 연결하여 열글자의 데이터를 보낸 후 종료하게 됩니다. 서버도 소켓을 끊고 종료하게 됩니다.

위의 예제를 실행시켜보았다면, 아직 소스는 보지 말고 공부를 시작해봅시다. 소켓은 TCP프로토콜을 사용하여 통신을 하는데 쓰인다고 앞에서 얘기했습니다. 따라서 소켓의 기본은 IP와 port겠죠. 이것들이 각각 무엇을 의미하는지는 알지 못해도 상관없습니다. 아무튼 IP는 컴퓨터마다 가진 고유한 주소이고, port는 통신을 위한 연결 라인과 같은 것이라고만 알고 있으면 됩니다. 아무튼 소켓을 사용하여 어떤 프로그램과 연결을 하기 위해서는 그 프로그램이 있는 컴퓨터의 IP와 소켓을 만든 port번호를 알고 있어야 한다는 것만 기억하면 됩니다.

1) 서버 소켓 준비하기( SocketServer.java )

통신을 하기 위해서는 먼저 서버에서 소켓을 준비해야 합니다. 자바에서는 그것을 위해 ServerSocket이라는 클래스가 제공됩니다. 다음과 같이 초기화를 하면 서버 소켓이 만들어집니다. 이것은 java.net 패키지에 들어있습니다.

ServerSocket 소켓변수이름=new ServerSocket(포트번호);

포트번호는 정수이고, 소켓변수이름은 아무것이나 변수로 쓸 수 있는 것을 써주면 됩니다. 예를 들면 ServerSocket srvSocket=new ServerSocket(5777); 라고 선언할 수 있겠죠.
다음은 이 서버소켓을 사용하여 클라이언트와 통신할 다른 소켓을 만들어주는 작업입니다. 서버 쪽에서는 반드시 두 개의 소켓이 필요합니다. 하나는 서버용 소켓인데 이것으로는 통신을 할 수가 없고 단지 클라이언트의 연결을 기다립니다. 따라서 클라이언트와 연결이 되면 실제로 통신을 하기 위해서는 소켓을 하나 더 만들어서 연결해주어야 한다는 것을 의미한다. 이 소켓은 서버소켓.accept()명령으로 만들어줄 수 있습니다.

Socket soc=srvSocket.accept();

여기서 srvSocket은 아까 선언해준 서버소켓의 이름이 됩니다. 클래스의 이름이 Socket임을 눈여겨 보아야 합니다. 클라이언트에서도 이 소켓을 사용하여 연결하게 됩니다.

다음은 입력을 위한 스트림을 선언하는 부분입니다. 물론 만들어 놓은 소켓에서 스트림을 얻어와야 하겠죠. 스트림은 java.io 패키지에 포함되어 있습니다.

InputStream is=soc.getInputStream();

이렇게 is는 스트림변수 이름이고, soc는 앞에서 선언한 소켓의 이름입니다. 이렇게 되면 입력스트림이 얻어졌습니다. 그리고나서, 이 스트림에서 입력을 받기위해서는 이 스트림을 읽을 수 있는 Reader를 정의해야만 읽을 수가 있겠죠. 마치 비디오테이프와 VTR과 같은 관계입니다. VTR에 비디오 테이프를 넣어주어야 하겠죠.

InputStreamReader isr=new InputStreamReader(is);

여기서 is는 앞에서 선언한 inputstream이고, isr은 InputStreamReader의 이름입니다. 이것으로 서버쪽에서 소켓을 준비하는 것은 모두 끝났습니다. 데이터를 읽기 위해서는 InputStreamReader에 있는 read()메소드를 사용하면 됩니다. 즉, int a=isr.read();와 같이 하면 a에 한 글자가 입력됩니다. int값으로 넘어오는데, 문자로 바꾸기 위해서는 형변환(type casting)을 해주면 되겠죠. char a=(char) isr.read(); 와 같이 하면 되겠죠. 들어오는 문자들을 하나의 문자열에 저장하기 위해서는 str=str+(char)isr.read(); 와 같이 문자열에 더해주면 됩니다.

2) 클라이언트 소켓 (SocketClient.java)

클라이언트 소켓은 서버 소켓보다 훨씬 쉽습니다. 서버 소켓은 필요가 없고, InputStream을 OutputStream으로, InputStreamReader를 OutputStreamWriter로 바꾸기만 하면 됩니다.

먼저 소켓을 만들어야겠죠. 앞에서 생성한 서버의 IP와 port번호를 알고 있어야 합니다.

Socket soc=new Socket("127.0.0.1", 5777);

여기서 "127.0.0.1"은 IP주소입니다. 앞에서 설명한대로 이것은 자기 자신을 의미합니다. 만약 서버가 다른 컴퓨터에 있다면 그 컴퓨터의 IP를 적어야 합니다. 5777은 포트번호입니다. soc는 물론 소켓의 이름으로 변수로 쓸 수 있는 것을 적어주면 됩니다. 여기서 아까 눈여겨봐야 한다던 것을 기억해서 Socket과 동일한 클래스를 사용하고 있다는 것을 확인하세요.

다음은 이 소켓에서 스트림을 생성하는 것입니다. 서버로 데이터를 보내는 것이니까 당연히 InputStream이 아니라 OutputStream을 사용해야 하겠죠.

OutputStream os=soc.getOutputStream();

이 문장이 잘 이해가 안가면 앞의 서버 쪽의 InputStream을 만드는 부분을 읽어보세요. 이제 앞에서와 마찬가지로 OutputStreamWriter를 만들어줘야 하겠죠.

OutputStreamWriter osw=new OutputStreamWriter(os);

이렇게 하면 writer까지 무사히 만들어졌습니다. 이제 데이터를 전송하기 위해서는 write()메소드를 사용하면 됩니다. 구체적으로 어떻게 사용하는지는 다음에서 배우기로 합시다.

3) 스트림을 통한 데이터의 입출력

앞에서 InputStreamReader와 OutputStreamReader를 만들었습니다. 이제 그 클래스에 구현된 메소드(read, write)를 사용해서 그냥 읽고 쓰면 됩니다. 자바 스펙 에서 InputStreamReader와 OutputStreamReader를 찾아 보세요. 찾기가 쉽지는 않겠지만, 앞으로 자바 공부를 하기 위해서는 하루에도 수십번 씩 해야 하는 일이니까 스스로 찾아보세요.

InputStreamReader에 보니까 read 메소드가 두 개로 정의되어 있네요.

  • int read();
  • void read(char[] chr, int offset, int length);

앞의 것은 설명에 한 글자를 얻어온다고 적혀있네요. 즉, a=isr.read();라고 하면 a에는 한 글자만 들어가 있다는 뜻입니다. a는 정수형(int)이어야 합니다. 이것을 문자로 바꾸기 위해서는 형변환(type casting)을 해주어야 합니다. 뒤의 것은 몇 번째 글자(offset)부터 몇 글자(length)를 얻어와서 char의 배열에 넣는다는 의미인 것 같습니다.

public static void main(String args[]) {
	InputStreamReader isr=new InputStreamReader(new ServerSocket(5777).accept().getInputStream());
	String str="";
	for (int i=0; i<10; i++) { str="str+(char)isr.read();" } System.out.println(str); isr.close(); } 

자 프로그램이 하나 완성되었습니다. InputStreamReader를 만들기 위해 ServerSocket을 만들고 그것의 accept()메소드를 이용해서 Socket을 만들고 다시 InputStream을 만드는 모든 과정을 그냥 한 줄로 끝냈습니다. 괄호의 가장 안쪽부터 차근차근 읽어보면 앞에서 설명한 순서로 만들어주었다는 것을 알 수 있습니다. 다음에는 str을 String으로 선언해주고 for문으로 열개의 문자를 읽어와서 str에 더해주고서 다시 str을 출력하는 프로그램이네요.
주의해야 할 점은 이 코드는 실행되지 않는다는 점입니다. 바로 다음에서 할 exception처리를 보고나면 이 코드를 수정하여 실행시킬 수 있습니다. 적당한 패키지(java.io, java.net)를 import하고, exception을 처리해서, 이 클래스를 SocketServer.java 클래스에 넣어주면 서버는 완성됩니다.

클라이언트부분은 좀더 쉽습니다.

 

public static void main(String args[]) { OutputStreamWriter osw=new 
        OutputStreamWriter(new Socket("127.0.0.1",5777).getOutputStream()); 
		String str="0123456789";
		osw.write(str,0,10);
		osw.flush();
		osw.close();
} 
 

아까와 마찬가지로 spec에서 찾아보면 OutputStreamWriter클래스에는 write()가 여러 개로 정의되어 있습니다. 한 글자씩 전송하는 것도 있고, 지금처럼 사용할 수도 있습니다. 지금은 str의 0번째 글자부터 10개의 글자를 전송하라는 의미입니다. osw.flush();는 글자를 실제로 전송하라는 의미입니다. 이것을 써주지 않으면 메시지를 받는 쪽에서 실제로 읽을 수가 없습니다.

방금 해보니까, 위의 코드들은 전부 실행이 되네요. 물론 exception처리를 해줘야 합니다. 그럼 시간 낭비하지 말고 어서 exception처리를 배워봅시다.

4) exception처리

exception은 단어 뜻 그대로 예외상황을 의미합니다. 만약 서버에서 서버소켓을 만드는데 사용하고자하는 포트(예를 들면 5777)가 사용중이라고 해봅시다. 그러면 소켓을 만들 수가 없겠죠. 하지만 이것은 컴파일할때는 에러가 나지 않습니다. 컴파일할때 포트를 사용하는지를 검사해보는 것은 의미가 없겠죠? 컴파일할때는 포트가 사용중이 아니더라도 실행할때 사용중일 수도 있으니까요. 클라이언트에서 소켓을 만들때도 마찬가지입니다. 만약 서버를 실행시키지 않은 상황이라면, 클라이언트를 아무리 잘 작성해서 실행시키더라도 소켓을 연결할 수가 없겠죠. 이러한 상황을 예외상황(exception)이라고 합니다. 예외상황은 오류(error)와는 전혀 다른 것입니다. 에러는 사용자가 코딩할때 실수해서 컴파일조차 안되는 상황이지만, 예외상황은 코딩은 잘되었더라도 시스템의 상황에 따라서 발생하는 것입니다. 예컨대, 에러는 컴파일할때, 예외상황은 실행할때 발생한다는 것입니다.

예외상황을 잘 잡아주는 것은 대단히 중요합니다. 지금처럼 서버 소켓을 만들었을때 예외상황이 발생하여 시스템의 자원(메모리, CPU사용 등)을 반환하지 않는다면 컴퓨터를 재부팅하기 전에는 계속해서 시스템의 자원을 잡아먹기 때문에 시스템을 느려지게하는 원인이 될 수 있죠. 자바에서는 물론 그런 일이 발생하지 않습니다. 자바 버추얼 머신(java.exe)을 통해서 실행이 되기 때문에 java.exe가 실행을 중지하면 모든 자원은 자동으로 반환되기 때문입니다. 하지만 C와 같은 프로그램에서는 예외상황에서 적절히 자원을 반환해주지않으면 앞에서 설명한 일이 발생하게 됩니다.

아무튼 예외 상황을 잡아주는 것은 프로그램의 신뢰성을 높이는데에 매우 중요합니다. 소켓을 만들 수 없을때는 최소한 소켓을 만들 수 없다는 메시지 정도는 출력해주는게 프로그래머의 당연한 의무겠죠. 이 소켓 프로그램(SocketServer.java Socket Client.java)에서 예외상황을 발생시킬 수 있는 메소드는 크게 두 가지가 있습니다. 첫째는, 1.소켓을 만들때, 앞에서 소켓을 만들 수 없다는 예외상황이 발생할 수 있습니다. 둘째는, 2.데이터를 입력받거나 출력할때 중간에 소켓이 끊겼거나 하는 상황에서 발생할 수 있습니다. 따라서 SocketServer.java / SocketClient.java에서는 각각 최소한 두 가지 씩의 예외처리를 해주어야 하겠죠.

예외상황의 처리는 try 와 catch문으로 처리할 수 있습니다. finally이라는 예약어도 있지만 이것은 여기서 생략하기로 하죠. 사용 방법은 C에서와 완전히 동일합니다. 예외상황이 발생할 수 있는 메소드를 try { }로 감싸고서 예외상황은 catch에서 잡아서 처리하는 것입니다. 직접 코드를 만들어 봅시다.


public static void main(String args[]) {
	try {
		// 아까 그 내용들....
	} catch (IOException e) {
		System.out.println("Exception이 발생했습니다.");
	}
}

이렇게 하면 됩니다. IOException은 여러 가지 예외상황중 IO(Input/Output)에 관계된 예외상황을 잡아내라는 의미입니다. 스트림이니까 예외상황은 IO에 관계된 것이겠죠. 이러면 실행을 주-욱 하다가 뭔가 예외상황이 발생하면 catch다음에 있는 문장을 실행하고 넘어간다는 의미입니다. 여기서는 "Exception이 발생했습니다."라는 메시지를 출력하겠죠.

물론 이렇게 하면 잘 돌아가지만 이상적인 예외처리라고는 할 수 없습니다. 왜냐면 예외상황을 발생할 수 있는 부분은 두 부분인데, 그냥 전체적으로 try catch로 묶어버려서 어느 곳에서 예외상황이 발생되더라도 그냥 "Exc.."라는 메시지만 출력하고 끝내버려서, 사용자는 도대체 어느 부분에서 예외상황이 발생했는지를 알 수 없다는 점입니다. 이렇게 되면 프로그래머는 코드 중 어디가 틀렸는지 알 수 없고, 또는 사용자는 자신이 뭘 잘못했는지를 알 수가 없겠죠. 따라서 가장 이상적인 방법은 try - catch를 예외를 발생할 수 있는 부분들에서 각각 써주어야 한다는 것입니다. 이렇게 하면 어떤 부분에서 예외 상황이 발생했는지를 알 수 있기 때문입니다.

//SocketClient.java
import java.io.*;    // Stream, Reader, Writer를 사용하기 위해
import java.net.*;   // Socket을 사용하기 위해
 
public class SocketClient {
 
  public static void main(String args[]) {
 
    OutputStreamWriter osw=null;
 
    try {
      osw=new OutputStreamWriter(new Socket("127.0.0.1",5777).getOutputStream());
    } catch (IOException e) {
      System.out.println("소켓을 만드는 데에 실패했습니다.");
      System.exit(-1);
    }

    String str="0123456789";

    try {
      osw.write(str,0,10);
      osw.flush();
    } catch (IOException e) {
      System.out.println("데이터 전송에 실패했습니다.");
    }  

    try {
      osw.close();
    } catch (IOException e) {
      System.out.println("소켓을 닫는데 실패했습니다.");
    }
  }
}

이제는 완전한 프로그램이 작성되었습니다. 막상 코딩해보니 예외상황(exception)이 두 부분이 아니라 세 부분에서 발생할 수 있군요. 소켓을 닫는 부분도 생각을 해야 하겠죠. 첫번째 예외처리에서 System.exit(-1);은 프로그램을 종료하라는 의미입니다. 소켓이 생성되지 않았다면 뒤에 있는 데이터를 전송하는 부분이나 소켓을 닫는 부분이 전부 의미가 없는 일이 되겠죠. 따라서 소켓이 생성되지 않았다면 프로그램을 종료하는 것이 좋겠죠.

서버쪽은 각자가 작성해 볼 수 있을 것입니다. 클래스를 만들어서 적당한 패키지를 import하고 예외처리만 해주면 서버도 잘 작동될 수 있을 것입니다. 그리고나서 여러 가지 상황을 체크해보세요.

  1. 서버를 돌리지 않는 상황에서 클라이언트만 실행해보기도 하고,
  2. 서버를 하나 돌리고, 똑같은 포트를 사용하는 서버를 한 번 더 실행해보세요.

5) 진짜로 만들어보기

앞에서 드디어 완전히 동작하는 소켓 프로그램을 작성하였습니다. 서로 완전히 독립적인 두 프로그램이 서로 통신을 하는 것이 대단히 신기하죠? 사실 프로그래밍에서 제일 재미있는 부분은 윈도우 프로그래밍(swing, awt)하고 소켓 프로그래밍인 것 같습니다. 하지만 이렇게 만들면 사실 동작은 하겠지만, 객체지향언어인 자바 프로그램이라고 말하기 힘들겠죠.

왜냐면 일단 클래스를 사용하지 않았습니다. 클래스는 사실 main메소드를 사용하려고 그냥 써준 것 뿐이지, 만들어놓은 클래스를 어디에서도 사용하지 않아서, 사실 C프로그램과 별로 달라 보이지 않습니다. 그래도 객체지향언어인데 자존심이 있지...

클래스를 제대로 구현하지 못한 이 프로그램은 클래스의 장점들을 사용할 수 없음을 의미합니다. 다른 클래스에서 사용하는 것은 완전히 불가능합니다.

그럼 과제로 생각하고, 제대로된 객체지향 방식에 의해 프로그래밍을 해보세요. 그 한 예가 처음에 제시했던 SocketServer.java / SocketClient.java가 될 수 있을 것입니다. 한 번 해보다가 잘 안되면 제가 작성한 프로그램을 참고해서 반드시 직접 코딩해보세요.

 

 

프로젝트2. 계산기 프로그램

이번에 작성할 프로그램은 계산기 프로그램입니다. 클라이언트에서 두 정수(int)와 연산자(+,-,*,/)를 보내면 서버에서 받아서 계산한 후 결과값을 클라이언트에 보내는 프로그램입니다. 이 프로그램은 앞의 프로그램과는 차이가 있습니다.

  • 앞의 프로그램에서 하나의 내용이 전송되고 나면 서버와 클라이언트가 종료되었지만, 이번 프로그램에서는 하나의 계산이 입력되고 나서도 서버는 계속해서 클라이언트의 입력을 기다리게 됩니다. 이것은 하나의 서버에 여러 개의 클라이언트가 접속할 수도 있음을 의미합니다.
  • 일방적으로 클라이언트에서 서버로 전송을 하는 것이 아니라, 클라이언트는 서버에 명령을 입력하고 나서 서버로부터의 결과를 기다리게 됩니다.
  • 입력받은 내용을 그대로 출력하는 것이 아니라, 어느 것이 수이고 어느 것이 연산자인지를 구별해야만 한다.

이번 프로젝트에서는 세 가지를 배우게 됩니다.

  • 프로토콜을 구성하는 방법
  • 다른 종류의 Reader와 Writer / Tokenizer의 사용
  • 전송과 수신을 동시에 하는 것
  • 서버에서 쓰레드를 사용하여 계속해서 연결을 기다리는 것
  • 소켓의 연결이 끊어졌을때 서버에서도 소켓 연결을 끊는 것

1) 프로토콜의 정의

먼저, 통신규약(프로토콜)을 먼저 정의해봅시다. TCP/IP나 Netbeui같은 것들을 프로토콜이라고 합니다. 프로토콜은 보내는 측과 받는 측에서 미리 약속한 일정한 형식 같은 것을 의미합니다. 물론 우리가 정의한 프로토콜이 TCP/IP같은 수준은 아니지만 아무튼 서버와 클라이언트가 어떠한 형식으로 서로를 구분할 것인지를 약속해야 하니까 일종의 프로토콜이라고 할 수 있습니다. 프로토콜을 잘 정의하는 것은 소켓 통신의 기본입니다. 프로토콜을 얼마나 잘 정의하느냐에 따라서 프로그래밍이 대단히 어려울 수도 있고, 쉬워질 수도 있습니다. 프로토콜을 잘못 정의하면 프로그램 중에 프로토콜을 바꾸어야 하는 경우도 생길 수 있습니다. 이런 경우에는 데이터를 전송하거나 수신하는 부분을 다시 다 바꾸어주어야 하므로 보통 힘든 일이 아니겠죠.

아무튼 일단 어떻게 해야할지 생각해봅시다. 소켓을 통해서 보내질 패킷(한 무더기의 데이터)은 두 종류가 있네요. 우선, 클라이언트에서 서버에 보내는 계산을 요청하는 패킷입니다. 여기에는 연산자와 두 정수가 들어가겠죠. 다음은, 서버에서 클라이언트에게 보내는 계산결과 입니다. 여기에는 결과값만 들어가면 되겠죠...라고 생각하면 안됩니다. exception처리! 이것은 프로그래머의 예의입니다. 클라이언트가 요청한 값이 잘못되었을 경우, 예를 들어 정수가 아닌 문자나 소수를 입력했거나, 정수가 두 개가 되지 않았을때, 알 수 없는 연산자를 보냈을 때, 0으로 나누려고 했을때... 등등의 경우에 서버는 요청한 계산이 잘못되었다고 에러메시지를 보낼 수 있어야 하겠죠.

클라이언트에서 서버에 보내는 것은 연산자와 두 정수입니다. 연산자에는 +,-,*,/ 네 종류가 있죠. 프로토콜을 구성하는 방법은 보통 많이 쓰는 것이 토큰의 중간 중간에 구분자를 넣거나, 아니면 하나의 토큰이 일정한 수의 byte를 차지하게 하는 것입니다.

분리자를 이용한 토큰의 구성예: +:123:456:\

 

이 경우에는 패킷의 크기를 알 수 없기 때문에 패킷의 끝에 적당한 문자로 끝임을 알려주는 문자를 넣어야 합니다. 지금은 \를 사용했습니다. 만약 문장의 끝을 나타내는 문자나 분리자(Delemeter)를 1이나 2같은 숫자로 쓴다면 어떨까요? 아마 진짜숫자를 분리자나 패킷의 끝으로 착각하는 경우가 생길 것입니다. 따라서 실제 데이터 속에는 포함될 수 없는 문자를 사용하여 분리자로 사용해야 하겠지요. 지금은 :가 분리자입니다. 패킷을 받는 계산기서버에서는 \가 나타날때 까지 하나씩 읽은 다음, 읽은 데이터를 :를 기준으로 끊어주어야 하겠죠.

일정한 공간을 차지하게 하는 예:+ 0123 0456

 

이 경우에는 크기를 정확히 알 수 있기 때문에 분리자나 패킷의 끝을 나타내는 문자 등은 덧붙일 필요가 없습니다. 받는 쪽에서는 첫번째 글자는 연산자이고, 다음 네글자는 숫자, 다음 네 글자는 다음 숫자라는 것을 바로 알 수가 있죠. 하지만, 이렇게 하면 나중에 4자리수 이상을 차지하는 계산기 프로그램으로 바꾸기 위해서는 프로토콜을 다시 정의해야 할 것입니다. 또한 경우에 따라서는 공간의 낭비도 아주 심합니다. 1을 나타내기 위해서도 4자리를 사용해야 하므로 그만큼 데이터의 양도 많아지고 전송 속도도 느려지겠죠.

프로토콜을 구성하기 위해서는 여러 가지를 고려해야 합니다. 우선 사용하는 언어에서 구현 가능해야 하고, 언어에서 지원하는 기능들로 쉽게 구현할 수 있어야 하며, 같은 내용을 나타내기 위해서 패킷의 크기가 너무 커지지 않아야 하며, 덧붙여 이후의 확장성까지도 고려해야 합니다. 앞서 얘기했듯이 프로토콜을 잘 정의하고 나면 앞으로의 경로가 순탄해지는 것이죠.

사실 이 프로젝트에 가장 적합한 프로토콜은 프로젝트1에서 사용했던 것입니다. InputStreamReader와 OutputStreamWriter에서는 기본적으로 정수를 기본으로 데이터를 전송하고 수신하는 메소드들이 있습니다. 따라서 앞에 연산자를 보내고, 다음엔 그냥 두 정수(int)를 전송하면 받는 쪽에서도 마찬가지로 받는 것은 read()와 write()메소드로 간단히 구현할 수 있습니다. 바로 정수로 전송하기 때문에 그대로 데이터를 사용할 수 있지만, 위의 두 방식은 받을때 문자열(String)로 받아야 하기 때문에 이것들 다시 정수(int)로 바꾸어주는 과정이 필요합니다.

그러나 이번 프로젝트에서는 첫번째의 delemeter를 사용하는 방식을 사용하도록 하겠습니다. 가장 많이 쓰이는 방식이기 때문일 뿐더러, 자바에서 제공하는 StringTokenizerBufferedReader(Writer)를 사용해보기 위해서입니다. 자바에서는 분리자에서 토큰을 분리해내는데에 StringTokenizer라는 클래스를 사용하면 아주 간단히 구현할 수 있기 때문입니다. 또한 BufferedReader는 InputStreamReader와 다르게 한 라인을 읽을 수 있는 기능(readLine())을 제공하기 때문에, 아주 편리합니다. 또한 다른 언어와의 통신에서 InputStreamReader와 OutputStreamWriter는 한글처리에서 가끔 문제가 발생하는데에 반해, BufferedReader(Writer)는 한글처리에 대단히 유리합니다.

클라이언트에서 서버에 보낼때, 분리자는 위에서와 같이 ':'를 사용하도록 하겠습니다. 그리고 패킷은 한라인 단위로 보내면 받는 쪽에서 readLine()을 이용하여 받으면 되겠죠. "연산자:정수:정수" 의 순서로 보내면 될 것 같네요.

서버에서도 분리자 :를 사용합니다. 성공(s)인지 실패인지(f)를 먼저 보내고, 다음에는 성공이면 결과값을 실패이면 에러메시지를 보내도록 합니다. 즉, 성공이면 "s:결과값", 실패이면 "f:에러메시지"의 형식이 되겠죠.

 

2) 클래스 설계1 : 클라이언트

클라이언트 부분은 앞에서 프로젝트1과 별반 다르지 않습니다. 소켓을 연결하는 부분은 완전히 동일하고, 단지 패킷을 보낸 다음 다시 서버에서 보낸 패킷(결과값)을 수신하는 부분이 추가될 뿐입니다. 이번 프로젝트에서는 앞에서와 같이 대충 기능만을 구현하는 것이 아니라 최대한 클래스를 효율적으로 설계해보도록 하겠습니다. 프로젝트1에서 클래스 설계를 다시 해서 한 번 작성해보라고 했는데 그말대로 실제로 프로그래밍을 해보았다면, 이번 프로젝트도 별로 어렵지 않을 것입니다. 클래스의 개념을 이해하는 것은 어렵지 않지만, 실제로 프로젝트에 적용하는 데에는 적잖은 고민이 필요합니다. 프로젝트1에서 클래스 설계를 해보았다면 그런 고민들을 한 번 이상씩 해보았을 것이고, 어떻게 하면 효율적인 설계가 될지 많이 생각해보았을 것입니다.

클라이언트의 클래스를 구성하는 방법은 여러 가지가 있습니다. 먼저 생성자에서 어떤 일을 해야 하는지를 생각해볼 수 있습니다. 생성자에서 IP와 port을 받아서 소켓 연결까지 모두 하게 할 수 있고, 생성자는 아무 일도 하지 않고 소켓 연결은 그것을 담당하는 다른 메소드를 정의해서 사용할 수도 있습니다.

또한 계산을 담당하는 메소드 또한 어떻게 인자를 받아야 하고 어떻게 반환을 할 것인지를 고려해야 합니다. 두 정수와 연산자를 모두 String으로 받을 수도 있고, 두 정수는 정수(int)로 연산자는 String이나 char로 받을 수도 있습니다. 계산 결과 또한 String으로 반환할 수도 있고, 정수형으로 반환할 수도 있습니다.

Exception처리 또한 고려의 대상입니다. 어디에서 exception을 처리할지가 문제입니다. 만약 데이터를 전송하는 데에 문제가 생겼다면 그자리에서 바로 예외상황을 처리할 것인지, 아니면 자신을 호출한 곳으로 exception을 넘겨서 거기서 호출하게 할 것인지.... 여러 가지 방법이 있습니다.

사실 클래스를 잘 설계하고도 실제로 코딩에 들어가면 설계할때 미처 생각하지 못한 부분이 생각나서 설계를 다시 수정해야 하는 경우가 한 두 부분이 아닐 것입니다. 이것은 뭐 프로그래밍을 많이 해보고 클래스 설계에 익숙해지고 know-how를 쌓아하는 방법밖에는 달리 지름길이 없습니다. 하지만 분명히 말할 수 있는 것은, 클래스 설계를 고려하지 않고 적당히 되는대로 코딩부터 시작해서는 언젠가 어려움에 봉착하게 될 것이라는 점입니다.

 

Example=Sample=...: 제가 한 설계는 다음과 같습니다. 생성자에서는 아무런 일을 하지 않게 하였습니다. 그리고 소켓을 연결하는 메소드(void socket_connect())를 따로 만들어서 여기에서 Reader와 Writer까지 잡게 하였습니다. 계산은 void calcul(int x, int y, String op)에서 하게 하였습니다. 보다시피 인자는 정수 두 개와 연산자를 String으로 넣게 하였습니다. 반환값은 없습니다. 이것은 결과는 정수로 에러는 문자열로 반환되어야 하기 때문에 계산하는 메소드에서는 반환값을 주지 않고, 결과는 int getResult()메소드에서 에러메시지는 String getError()에서 얻을 수 있도록 하였습니다. 계산이 에러 없이 잘 되었는지는 boolean isSuccess()로 알 수 있습니다.

  • public CalculClient(String ServerIP, int port);
  • public void socket_connect();
  • public void calcul(int x, int y, String operator);
  • public boolean isSuccess();
  • public int getResult();
  • public String getError();

각각의 메소드에 대해서는 따로 설명이 필요하지 않을 듯하다. 소켓 연결은 socket_connect()에서 하고, 서버에 데이터를 전송해서 결과값을 받는 일은 calcul()메소드에서 하게 됩니다. 이것을 구현하기 위해서 필요한 인스턴스(클래스 변수)는 다음과 같다.

  • private int result=0; // 결과값이 저장됩니다.
  • private String error; // 에러 메시지가 저장됩니다.
  • private boolean success; // 계산이 성공하면 true, 에러가 나면 false
  • private String ip; // 서버의 IP를 저장합니다.
  • private int port; // 소켓의 포트를 저장합니다.
  • private Socket socket; // 소켓입니다.
  • private BufferedReader; // 데이터를 읽을 Reader입니다.
  • private BufferedWriter; // 데이터를 전송할 Writer입니다.

그리고 IOException은 모두 자신을 호출한 곳에게 던져주기로 했습니다. 그 방법은 다음에 설명을 하기로 하구요, 아무튼 socket_connect()나 calcul()등을 호출하고서는 Exception을 받아서 처리하는 문장을 만들어주어야 하겠죠.

여기서 isSuccess()와 getResult(), getError()메소드는 아주 간단하리라 생각합니다. 그냥 각각, success, result, error값을 return해주기만 하면 되겠죠.

 

	public boolean isSuccess() {
		return success;
	}
	
	public int getResult() {
		return result;
	}
	
	public String getError() {
		return error;
	}

3) 클래스의 구현1: 클라이언트

정수 x, y와 문자열로된 연산자(+,-,*,/)를 입력받아서 서버에 계산을 요청하는 패킷을 보내고서 결과를 받아서 분석하는 부분을 해봅시다.

int x, y;에는 각 수가 들어갈 것이고, String op에는 +,-,*,/ 중의 하나가 들어갈 것입니다. 앞에서 설계한 패킷의 구조를 기억해내보세요. 13+24를 계산하기 위해서는 " +:13:24: "라는 패킷을 만들어야 합니다. 패킷은 아주 간단하게 만들 수 있겠네요. 그냥 스트링에 더하기만 하면 되니까요.

String packet=op+":"+x+":"+y+":";

op는 String이고 ":"도 String이니까 더하는 것이 이해가 되지만 여기에 x를 더하는 것은 얼핏 이해가 되지 않습니다. x는 정수인데 문자열에 더하고 있으니까요. 자바의 이상한 점 중의 하나인데, 아무튼 String에는 정수(int), 소수(float)를 더해도 String이 되고, 심지어 boolean값을 더해도 그냥 문자열에 더해집니다. 좀 이상하긴 하지만 아무튼 지금은 사용하기에 아주 편리하군요. 다음엔 만든 패킷을 전송한 다음, 결과값을 반환 받는 것을 해봅시다.

bw.write(packet);
bw.newLine();
bw.flush();                                // 패킷을 전송한다.

String result=br.readLine();         // 결과로 서버에서 날아온 패킷을 받는다.

bw.newLine()과 bw.flush()가 하는 역할에 대해서는 저번에 설명을 하였습니다. 서버쪽에서 라인 단위로 읽기 때문에 라인이 끝났다는 표시를 해주어야 하고, 버퍼에 쌓아둔 패킷을 전송하라는 명령을 내려주어야만 합니다.

서버에 패킷을 전송한 다음에 바로, readLine()을 써서 결과값을 얻는 군요. 실행을 시키면 bw.flush()까지 실행을 하고서 서버가 데이터를 보낼때 까지 기다리다가 서버에서 패킷을 보내면 readLine()에서 한 라인을 읽고서는 진행됩니다. 코드상으로는 붙여써주었지만, 실제로는 bw.flush()와 br.readLine()사이에는 많은 시간이 걸리는 것이고, 만약 서버에서 데이터를 보내지 않는다면 이 부분에서 정지해 있게 됩니다.

서버에서 전송한 결과값(result)를 분석해봅시다. 서버에서는 성공했을 경우 " s:결과값 ", 실패했을 경우 " f:에러메시지 " 와 같이 패킷을 보내게 됩니다. 앞에서 13+24라는 메시지를 보냈다면, " s:37"이라는 패킷이 날아오겠죠. 만약 3/0을 계산하라는 패킷을 보내면 "f:0으로 나눌 수 없습니다."라는 메시지가 날아옵니다. 그러면 클라이언트에서 그것을 적절히 분석해서 성공이면 결과값 37을, 실패이면 에러메시지를 내보내면 됩니다.

패킷을 분석하기 위해서는 StringTokenizer를 사용합니다. 프로젝트2를 시작하면서 이 클래스를 사용하겠다고 얘기했던 것이 기억날 것입니다. 이름 그대로 String을 Token으로 만들어주는 일을 합니다. token이란 단어와 비슷한 것이라고 할 수 있습니다. 의미를 가지는 데이터 단위니까요. 서버에서 날아오는 패킷은 토큰을 2개 가지고 있습니다. 성공(s)인지 실패(f)인지를 뜻하는 것과, 결과값 또는 에러메시지 입니다. "s:37"이라면 s와 37이 토큰이 됩니다. StringTokenizer를 사용하는 방법은 매우 간단합니다. 생성자에 스트링과 분리자(Token Delemeter)를 넣어주면 nextToken()이라는 메소드로 토큰을 하나씩 분리해 낼 수 있습니다.

 

int re=0;
String error="";StringTokenizer st=new StringTokenizer(result, ":");
String success=st.nextToken();

if ( success.equals("s") ) { re=Integer.parseInt(st.nextToken()); 
} else { error=st.nextToken(); }

아주 간단하죠? 스트링 토크나이저를 만든 다음, 토큰을 한 분리해서 그것이 "s"이면 다음 토큰을 분리해서 정수로 바꾼 다음 결과값에 넣고, "s"가 아니면 다음 토큰을 에러메시지에 넣는 것입니다.

4) 클래스 설계2 : 서버

서버 쪽은 약간 어렵습니다. 계속해서 클라이언트의 데이터를 기다리다가 받아서 계산을 하는 부분이 Thread를 사용하여 구현되어야 하기 때문입니다. 그 이유는 thread를 사용하면 하나의 서버에 여러 개의 클라이언트가 각각 독립적으로 접속할 수 있고, CPU점유율을 줄일 수 있다는 것입니다. 아무튼 그냥 서버 클래스를 설계해보자고 말하면 너무 잔인한 일이 될 것 같으니까, 서버가 돌아가는 메카니즘은 함께 공부해보고서 구체적인 클래스의 설계는 각자 해보고서 클래스 구현 부분에서 저의 설계와 비교해보도록 합시다.

 

Thread는 process와 비슷합니다. process 안에서 돌아가는 별개의 process 같은 것입니다. 윈도우나 리눅스, 유닉스와 같은 멀티태스킹 운영체제에서 에서 여러 개의 process가 돌 수 있는 것처럼 하나의 프로세스에서도 여러 개의 thread가 돌 수 있습니다. 하지만 process와 thread의 차이점은 문맥교환(context switching)이 일어나지 않는다는 것입니다. context란 하나의 프로세스가 돌아가는 환경이라고 볼 수 있습니다. 보통 레지스터 변수들의 값을 말하는데, 하나의 process는 하나의 context를 가지게 되므로, 두 개의 프로세스가 번갈아 실행되기 위해서는 계속해서 context switching이 일어나야 합니다. 그러나 thread는 process내부에서 돌기 때문에 문맥교환은 일어나지 않습니다. 아무튼 자세한 것은 알 필요가 없고 아무튼 하나의 프로그램에서 여러 개의 thread가 돌면서 Multi Tasking을 할 수가 있다는 것입니다.

그러나 서버도 소켓을 열고 -> stream과 Reader를 얻어낸 후 -> 데이터를 읽고 -> 계산한 결과값을 전송한다는 기본 구조는 변함이 없습니다. 이번에는 이 과정이 계속해서 반복된다는 점이 다를 뿐이죠. 서버이기 때문에 가장 앞 부분에 서버소켓을 만드는 부분을 더 추가해야 할 것 같군요. 기억하시겠지만, 소켓 연결은 가장 먼저 서버 소켓을 만든 후, 여기에서 소켓을 얻어내고 클라이언트 쪽에서는 이 소켓에 연결을 합니다. 아무튼 기본 구조는 비슷할 테니 서버쪽도 클래스 설계를 해봅시다.

가장 먼저 해야할 일은 적당한 포트에 서버 소켓을 만드는 일입니다. 생성자에서 해도 좋고 메소드를 하나 만들어도 좋습니다.

ServerSocket srvSocket=new ServerSocket(6000);

과 같은 식으로 하면 되겠죠. 다음에 할 일은 서버 소켓에서 accept()메소드를 이용해서 클라이언트와 연결할 소켓을 만드는 일입니다.

Socket socket=srvSocket.accept();

와 같이 하면 소켓을 열 수 있습니다. 여기까지는 프로젝트1에서와 같지만, 여기서부터 Thread를 사용합니다. 여기서 만들어준 소켓을 인자로 넣어서 Stream과 Reader, Writer를 만드는 일은 Thread를 하나 생성해서 일을 맞기는 것이죠. 서버는 계속해서 다른 클라이언트의 연결을 기다리고, 클라이언트와의 데이터 송수신은 생성된 Thread가 맡게 되는 것입니다.

즉, 서버는 서버 소켓을 만들어, 클라이언트의 연결을 기다리다가, 클라이언트가 연결이 되면, Thread를 하나 생성해서 만들어진 socket을 넘겨주고나서는 thread를 시작시키고서 다시 다른 클라이언트의 연결을 기다리게 됩니다. 

지금까지의 과정을 정리해 봅시다.

ServerSocket srv=new ServerSocket(port);      // 서버 소켓을 만듭니다. port는 포트 번호
while (true) {
  Socket socket=srv.accept();         // 클라이언트의 연결을 기다립니다.
                                      // 연결되면 다음행으로 진행됩니다.
  ServerThread t=new ServerThread(socket);  // Thread를 생성합니다. 이때 소켓을 인자로 넘겨줍니다.
  t.start();                          // 생성된 Thread를 구동시킵니다.
}

서버 클래스에서 할 일은 이정도가 다입니다. 서버 소켓을 만들고서는, 클라이언트 소켓을 연결해서 Thread를 생성해서 구동시키는 일은 무한루프로 돌고 있는 것을 알 수 있습니다. while (조건) { 항목 } 문은 괄호 안의 조건이 성립되면 블럭으로 싸인 항목들이 계속해서 실행되는데, 괄호 안의 조건이 true니까 절대로 끝날 일이 없는 무한 루프겠죠. 물론 Control-C를 누르면 종료됩니다. 아무튼 이 부분은 무한 루프로 돌고 있는데, 따라서 서버는 계속해서 돌면서 클라이언트의 연결을 기다리다가 클라이언트가 연결되면 socket을 연결하고 Thread를 만들어서 socket을 넘겨주는 일을 반복하게 되겠죠. 무한히 많은 클라이언트들이 연결될 수 있습니다. 자바가 네트워크 프로그래밍에 강한 이유 중의 하나가 Thread에도 있습니다. 하나의 서버에 많은 클라이언트들이 연결되더라도 이들을 따로 관리할 필요가 없습니다. 그냥 각각 별개의 thread를 만들어주기만 하면 thread내에서 알아서 일을 하기 때문입니다.

Threadclass에서는 결과값을 전송한 후 다시 처음으로 가서 클라이언트의 데이터 전송을 기다리게 됩니다. 서버는 루프를 돌면서 클라이언트 thread를 구동한 후 다시 다른 클라이언트의 연결을 기다려, 연결이 있다면 새로운 thread를 다시 생성합니다.

ServerThread는 구현해야 하는 클래스입니다. 사실 어려운 부분은 이부분이죠. 물론 다른 이름을 써도 전혀 상관은 없습니다. 그럼 ServerThread가 해야 하는 일을 짚어 봅시다. 클라이언트에서 연결된 소켓을 넘겨받았으니까 이 소켓에서 Stream을 만들어서 StreamReader와 Writer를 만들어내야 합니다.

InputStream is=socket.getInputStream();
OutputStream os=socket.getOutputStream();

InputStreamReader isr=new InputStreamReader(is);
OutputStreamWriter osw=new OutputStreamWriter(os);

그러나 우리는 BufferedReader와 BufferedWriter를 사용하기로 했습니다. 만들어놓은 InputStreamReader와 Writer를 BufferedReader와 Writer의 생성자에 넣어 주면 됩니다.

BufferedReader br=new BufferedReader(isr);
BufferedWriter bw=new BufferedWriter(osw);

 

is, isr, br / os, osw, bw 같은 많은 변수들을 만들기 귀찮은면 그냥 한 번에 끝내버리는 방법도 있습니다.

BufferedReader br=new BufferedReader(new InputStreamReader(socket.getInputStream()));
BufferedWriter bw=new BufferedWriter(new OutputStreamWriter(socket.getOutputStream()));

이제 남은 일은 br.readLine()에서 패킷을 읽어서 결과를 계산한 후 bw.write()를 이용해서 전송하기만 하면 됩니다.

String packet=br.readLine();
String result=analyzePacket(packet); // 패킷을 처리한다. String result에 결과 값이 저장된다.
bw.write(result);
bw.newLine();
bw.flush();

이렇게 하고 exception 처리만 하면 사실상 소켓 연결 부분은 모두 끝납니다. 남은 작업은 실제 프로그래밍에서 많이 하게 되는 일인데, 문자열(String)로 입력된 데이터를 분석하여 정수와 연산자로 나누고서 결과를 계산한 다음, 클라이언트에 전송할 패킷을 만드는 일입니다. 바로 analyzePacket()메소드에서 할 일이죠. 앞에서 프로토콜을 정의하고, 소켓을 Buffered로 할 것인지 그냥 StreamReader, Writer로 할 것인지를 고민했던 문제는 바로 이 부분을 쉽게할 수 있도록 하기 위해서라고 해도 틀린 말이 아닙니다. 지금은 데이터가 적어서 많이 어려워지거나 쉬워지지는 않지만, 데이터 량이 많거나 데이터의 종류가 다양하면 프로그래밍에서 가장 어려운 부분은 바로 이 부분이 됩니다.

5) 클래스 구현2: 서버 데이터 수신과 전송

서버 소켓을 만들고 클라이언트 소켓을 연결해서 쓰레드로 연결시키는 것 까지는 지금까지 설명이 되었다. 한 번 실제 코딩과 비슷하게 알고리즘을 그려보자. 서버 클래스인 CalculServer.java에서 할 일은 간단합니다. 그 알고리즘은 앞에서 설명하였습니다. 하지만 어떤 일을 어떤 메소드에서 해야하고 밖에서는 어떻게 호출해줄 것인지 하는 일들은 클래스 설계에서 각자 해보았을 것입니다. 그럼 제가 한 클래스 설계를 보여드리겠습니다. 뭐 표준안이라고 할 수는 없을테니까 다르더라도 너무 상심하지는 마세요.

 

// CalculServer.java


public class CalculServer {


  public void socket_connection(int port);    // 서버 소켓 생성
  public void listening();                    // 클라이언트의 연결을 기다리고,
                                              // 연결되면 thread를 구동
}


class ServerThread extends Thread {
  
  public void run();            // 소켓에서 reader, writer를 얻어서 데이터를 받는다.
                                // analyzePacket()을 호출하여 결과를 얻어 전송한다.
  public String analyzePacket(String inputPacket);
                                // 패킷 내용을 분석하여 계산하고
                                // 클라이언트에 전송할 패킷을 만들어 반환한다.

}

이렇게 보니까 클라이언트 클래스보다 더 간단하네요. 하지만 내용은 그리 쉽지 않습니다. analyzePacket()메소드를 구현하는 것이 쉽지가 않겠죠? "+:13:24"라는 String을 분석해서 "s:37"이라는 String을 만들어낼 수 있어야 하니까요.

아무튼 클래스 두 개로 구현되어 있네요. ServerThread클래스는 CalculServer클래스 안에 포함 되어도 좋고 지금처럼 밖에 나와있어도 상관없습니다. 하지만 public클래스는 CalculServer클래스 하나밖에 없어야 합니다. ServerThread도 아예 ServerThread.java라는 다른 화일에 구현하는 것은 상관없습니다.

ServerThread클래스는 Thread를 상속하고 있네요. 이렇게 되면 이 클래스는 thread가 되는 것입니다. CalculServer클래스에서 ServerThread클래스를 생성해서 start()메소드를 호출하면 자동으로 ServerThread의 run()메소드가 호출됩니다. 클라이언트에서 데이터를 입력받아서, analyzePacket()메소드를 사용하여 결과값을 만들어서 클라이언트에 보내주면 됩니다. 이 과정은 물론 루프로 돌고 있어야 하고, 만약 클라이언트의 연결이 종료되면 루프가 끝나면서 run()메소드도 종료되어야 합니다. run()메소드의 실행이 끝나면 thread는 자동으로 끝나게 됩니다.

클래스 구현에 대해서는 특별히 더 할 이야기가 없네요. 어떻게 하는지를 알아야 설계가 가능하기 때문에 구현 방법까지 전부 다 설명을 해버렸더니... 그냥 넘어가면 서운하니까 여기서는 두 가지만 설명을 하도록 하겠습니다. run()메소드에서 소켓의 연결을 기다리는 루프와 소켓 연결이 끊겼을 경우를 찾는 것과 exception처리의 좀더 고급 기술을 설명하겠습니다.

먼저 run()메소드는 앞서 말했듯이 루프를 돌고 있어야 합니다. 왜냐면 클라이언트가 데이터를 하나만 전송하고 끝내는 것이 아니라 계속해서 연결을 유지하면서 데이터를 주고 받아야 하기 때문입니다. 따라서 클라이언트가 접속되어 있는 한 이 Thread는 유지되어야만 하고, 클라이언트의 연결이 종료되면(사용자가 프로그램을 끊거나, 랜선이 끊어졌거나, 컴퓨터가 꺼졌거나.. 등등), 자동으로 Thread는 종료될 수 있어야 합니다. 대단히 어려운 작업인 것 같지만, 실제 구현은 간단합니다. 클라이언트의 접속이 끊기면 데이터를 읽으려고 할때 즉시 IOException이 나기 때문입니다. 즉, 그냥 데이터를 읽다가 exception만 잡아주면 됩니다. 예외상황이 발생하면 클라이언트와 연결이 끊어진 것이니까, 루프에서 빠져나가서 소켓을 끊고 run()메소드를 종료하면 thread도 종료되는 것입니다.

 

public void run() {
  String rcvPacket="";
  String sndPacket="";
  
  while (true) {

    try {
      rcvPacket=br.readLine();
      sndPacket=this.analyzePacket(rcvPacket);
      bw.write(sndPacket);
      bw.newLine();
      bw.flush();
    } catch (IOException e) {
      System.out.println("클라이언트의 연결이 끊겼습니다. 소켓을 끊겠습니다.");
      break;                   // while 루프 밖으로 나간다.
    }
  }

       // 소켓 연결을 종료한다.
  try {
    br.close();
    bw.close();
    socket.close();
  } catch (IOException e) {
  }

}

while(true) 로 인해 무한 루프를 돌게 되지만, 데이터를 읽거나 쓸때 exception이 나오면 바로 메시지를 출력하고 루프를 빠져 나오게 작성되어 있는 것을 볼 수 있습니다.

다음엔, exception처리를 배워봅시다. 지금까지 try - catch를 이용해서 exception을 잡아냈습니다. 하지만 어떤 메소드는 그냥 호출하면 되지만, 어떤 메소드는 try - catch 로 exception을 잡아주지 않으면 컴파일까지 되지 않는다는 것은 두 종류의 메소드에 어떤 차이점이 존재한다는 말이겠죠. 물론입니다. 그런 메소드를 작성할 수도 있고, 꼭 그렇게 작성해주어야 하는 경우도 있습니다. 다음 메소드를 보기로 합시다.

public void socket_connection() throws IOException {
  try {
    Socket socket=new Socket("127.0.0.1", 6000);
  } catch (IOException e) {
    throw e;
  }

}

설명을 하지 않아도 어떤 내용인지는 금방 이해할 수 있을 것입니다. 메소드를 선언할 때 뒤에 throws <Exception 종류> 를 붙여주었습니다. 이런 메소드를 사용할 때는 반드시 try - catch를 사용하여 exception을 잡아주어야만 합니다. 메소드 중간에 exception이 발생하면 throw e; 라는 명령을 실행시키는 것을 볼 수 있습니다. 이것은 발생한 exception을 그대로 메소드 바깥으로 전달한다는 의미입니다. 이렇게 하면 메소드 안에서 exception이 발생하면 그 exception은 메소드 안에서 처리되지 않고 메소드를 호출한 곳까지 exception이 그대로 전달되게 됩니다.

이런 방법은 대부분의 경우 메소드 내에서 exception을 처리하는 것보다 훨씬 좋은 방법입니다. 다시 말하면 최종적으로 사용하는 곳에서 exception을 처리하는 것이 훨씬 좋다는 의미이죠. 왜냐하면 위의 메소드에서 소켓 연결에 실패해서 exception이 발생했다고 칩니다. 지금처럼 메소드를 전달하지 않고, 이전에 하던 방식으로 System.out.println(e.toString()); 과 같은 식으로 에러 메시지를 내보낼 수도 있습니다. 그러나 awt나 swing을 사용하는 어떤 프로그램에서 이 클래스를 사용하여 네트워크 프로그램을 작성하고자 한다고 생각해보세요. 만약 어떤 exception이 나면 Text Area나 Label 같은 윈도우 안에 나타나게 하고 싶지만, 메소드 바깥에서는 어떤 exception이 났는지 알 수도 없고, System.out.println()명령으로는 Text Area에 출력할 수도 없습니다. 따라서 메소드 내에서 exception이 나면 그 exception은 안에서 처리하는 것보다는 대부분 메소드를 호출한 곳에서 처리해 주는 것이 좋습니다. 물론 이것은 '대부분'의 경우이고, 그렇지 않을 수도 있습니다.

6) 클래스 구현3: 서버 패킷 분석과 결과값 계산

analyzePacket()메소드를 구현해봅시다. 클래스구현1(클라이언트)에서 했던 것 같이 StringTokenizer를 사용합니다. 과정은 다음과 같습니다.

인자로 넘겨받은 문자열(String rcvPacket)과 분리자( delemeter = : )을 넣어서 StringTokenizer st를 생성합니다.

  1. st.nextToken()으로 연산자를 얻습니다.
  2. st.nextToken()으로 첫번째 수를 얻습니다.
  3. st.nextToken()으로 두번째 수를 얻습니다.
  4. 연산자가 +이면 두 수를 더하고, -이면 두수를 빼고...
  5. 계산에 성공하였으면 "s:"+결과값 으로 클라이언트에 전송할 패킷을 만듭니다. 실패이면 "f:"+에러메시지 로 전송할 패킷을 만듭니다.
  6. 만든 패킷을 반환합니다.(return)

물론 클라이언트에서 항상 올바른 패킷만 넘어오라는 법은 없으므로 에러처리를 해주어야 합니다. 연산자가 틀리거나, 0으로 나누거나, 숫자가 아닌 문자가 넘어오거나 하는 경우들입니다. 에러처리는 각자 구현해보도록 합니다.

7) 참고예제: 제가 작성한 프로그램입니다.

제가 작성한 프로그램입니다. 한 번 실행시켜보시고, 각자 작성한 코드와 소스를 비교해 보세요.

  • CalculServer.java : 계산기 서버입니다. 포트 번호를 파라미터로 줄 수 있습니다.(default=5777) 사용방법: java CalculServer [port]
  • CalculClient.java : 계산기 서버와 통신을 통해 계산을 합니다. main함수는 테스트 용으로만 만들었기 때문에, 사용자 입력을 받을 수 없고 그냥 세 가지 계산을 하고 종료됩니다.
  • Calculator.java : 계산기입니다. 키보드로부터 입력을 받아서 CalculClient를 사용하여 계산을 수행합니다. 키보드로부터 입력 받는 것도 지금까지의내용을 통해 금방 이해할 수 있습니다. 사용방법: java Calculator [port] [Server IP]

먼저 세 화일을 컴파일하고서 서버를 실행시킵니다.

SHELL> java CalculServer [port 번호]

다음은 다른 콘솔에서 Calculator를 실행시킵니다.

SHELL> java Calculator [port 번호] [Server IP]

 

 

 

프로젝트3. 채팅프로그램

지금까지 프로젝트를 어떻게 진행해왔는지를 생각해봅시다. 첫번째 프로젝트는 그냥 서버를 하나 띄우고, 클라이언트를 실행시키면 서버에 데이터를 한 번 보낸 후 프로그램을 종료했습니다. 두번째 프로젝트는 하나의 서버에 여러 클라이언트가 연결할 수 있었지만, 데이터 전송에 있어서는 하나가 가면 하나가 오고 하는 식이었습니다. 이번 프로젝트가 가지는 차이점은 채팅 프로그램을 생각하면 쉽게 알 수 있는 것들인데, 다음과 같습니다.

  • 이전에는 패킷을 한 번 보내고서 응답을 기다렸지만, 이번 프로젝트에서는 서버에서 비동기적으로(아무때나) 데이터를 보냅니다. 왜냐하면 다른 클라이언트에서 서버로 보낸 메시지도 받아야 하기 때문입니다.
  • 서버에서는 이전에는 패킷을 보낸 클라이언트에게만 결과값(패킷)을 전송했지만, 지금은 하나의 클라이언트에서 데이터가 보내지면 다른 모든 클라이언트에게 메시지를 보내야만 합니다.
  • 서버에서 생성한 thread가 이전에는 독립적으로 클라이언트와 통신하는 모든 역할을 담당했지만, 이번에는 서버로부터의 요구에 의해 언제라도 클라이언트에게 메시지를 보낼 수 있어야 하고, 역으로 클라이언트로부터 메시지를 받으면 서버에게 다른 모든 클라이언트에게 메시지를 전송하라고 요청해야 합니다. 따라서 서버가 생성한 thread가 서버와 통신을 할 수 있어야 합니다.

 

따라서, 프로젝트2에서 했던 것과 같이 데이터를 보내고서 바로 결과를 기다리거나(클라이언트), 반대로 데이터를 받고 바로 그 클라이언트에게 응답을 보내는(서버) 방식이 아닌 다른 방식이 요구됩니다. 다음과 같은 방식으로 채팅 프로그램을 작성할 수 있습니다.

  • 클라이언트에서도 서버로부터의 데이터를 받기 위해 Thread를 사용합니다. 데이터를 보내는 것은 사용자가 내용을 입력했을 때이지만, 서버로부터의 데이터는 아무때나 올 수 있기 때문에 서버로부터 응답을 받는 부분은 thread로 작성되어야만 서버의 데이터 전송에 바로 응답할 수 있습니다.
  • 서버에서는 클라이언트가 연결되면 단지 Thread를 만들고 thread에게 모든 역할을 일임하는 것이 아니라, 만든 thread의 목록을 가지고서 하나의 thread가 메시지를 받으면, thread는 서버에 메시지를 받았다는 신호를 보내고, 서버는 thread 목록에 의해서 모든 클라이언트에게 데이터를 전송해야 합니다.
  • thread가 서버와 교신할 수 있도록, thread를 생성할때 서버 자신의 레퍼런스를 넘겨줍니다. 그러면 thread에서는 서버에 메시지를 보낼때, 서버의 메소드를 호출할 수 있습니다.

계산기 프로젝트까지 성실히 따라 왔다면 클라이언트에서도 thread를 생성하는 부분은 어렵지 않을 것입니다. 클라이언트에서 서버로 메시지를 보내는 것은 전과 같지만 메시지를 받는 부분은 thread를 생성하여 넘겨주어야 합니다. 이를 위해 thread를 생성할때, 소켓 또는 Reader를 함께 넘겨주어서 데이터를 받도록 해야 합니다. 또한 클라이언트에 있는 화면에 메시지를 출력하기 위해서는 클라이언트의 레퍼런스도 함께 넘겨주어야 합니다.

1) 프로토콜 정의

이 프로그램에서는 별다른 프로토콜 정의가 필요하지 않을 것 같네요. 아무것도 정의하지 않는 것도 하나의 정의라고 할 수 있겠지만서도... 아무튼 클라이언트에서 한 줄 문장을 보내면, 서버에서는 보낸 사람 아이디와 합쳐서 다른 클라이언트들에게 보내주면 되겠죠. 아이디를 바꾸는 것이나, 도움말 보기 같은 기능들은 서버나 클라이언트에서 받은 텍스트를 분석하는 기능을 넣으면 되겠죠.

이번에도 한 줄 씩의 메시지를 주고 받게 되니까 readLine() 메소드가 있는 BufferedReader와 BufferedWriter를 사용하는 것이 좋겠네요.

2) 서버 설계1: 소켓 준비와 Thread리스트 만들기

이 부분도 계산기 프로젝트와 별반 다르지 않습니다. 단지 thread를 생성할때, 인자로 자기 자신을 넘겨주는 것과, 생성한 thread를 목록에 넣어두는 것이 다르죠. 일단 프로젝트2에서와 같이 서버 부분의 소켓과 thread 구동까지 구현하고서, 수정하도록 해봅시다. 다음과 같겠죠.

ServerSocket srv=new ServerSocket(port);      // 서버 소켓을 만듭니다. port는 포트 번호
while (true) {
  Socket socket=srv.accept();         // 클라이언트의 연결을 기다립니다.
                                      // 연결되면 다음행으로 진행됩니다.
  Thread t=new ServerThread(socket);  // Thread를 생성합니다. 이때 소켓을 인자로 넘겨줍니다.
  t.start();                          // 생성된 Thread를 구동시킵니다.
}

여기까지는 모두 알고 있겠죠? 여기서 더 추가되어야 할 내용은 생성한 thread의 목록에 넣는 것입니다. 목록은 배열로 만들어도 좋고, 리스트를 구현해도 좋겠죠. 배열은 만들기는 쉽지만, 처음부터 사용하고자하는 최대한의 공간을 잡아주어야 하기 때문에 메모리 낭비도 심하고, 중간에 사용자가 나가는 경우, 그 빈공간을 채우기 위해 뒤에 있는 내용을 하나씩 앞으로 당겨주어야 하는 불편이 있습니다. 리스트는 배열의 단점을 극복할 수 있지만, 포인터가 없는 자바에서 구현하는 것이 원칙적으로 불가능하죠. 하지만, 걱정할 것은 없습니다. Vector라는 클래스를 사용하면 간단하게 해결되기 때문입니다. 이 클래스의 세부적인 사양은 자바스펙을 보도록 하고, 지금은 중요한 메소드만 몇 개 알아봅시다.

 

class Java.util.Vector

  • void addElement(Object obj) : 내용(객체)을 추가할 때 사용합니다.
  • Object elementAt(int index) : 주어진 위치(index)에 있는 내용을 참조합니다.
  • boolean removeElement(Object o) : o와 같은 객체 목록에서 삭제합니다.
  • void removeElementAt(int index) : 주어진 위치에 있는 객체를 삭제합니다..

Vector v=new Vector(); 라고 선언되어 있다면 v에 추가하기 위해서는 v.addElement(obj);를, 삭제하기 위해서는 v.removeElementAt(index)를, 참조하기 위해서는 v.elementAt(index)를 사용할 수 있겠죠. 위의 프로그램에서는 일단, 처음에 Vector클래스를 하나 만들고서, thread를 생성한 후 벡터에 추가해주면 됩니다. 그러면 프로그램은 다음과 같이 수정되겠죠. 내친 김에 exception처리까지 해서 코딩을 해봅시다.

 

ServerSocket srv=new ServerSocket(port);
Vector client=new Vector();

while (true) {
  try {
    Socket socket=srv.accept();
    ServerThread t=new ServerThread(socket, this);
    t.start();
    client.addElement(t);
  } catch (IOException e) {
    System.out.println("Connect to Fail!!");
  }

}

하나 주의할 점은 Vector가 이 메소드 밖에서 정의되어 있어야 한다는 점입니다. 그렇지 않으면 이 벡터는 이 메소드 안에서만 사용할 수 있게 되겠죠. 또 하나는 thread를 생성할 때 자기 자신(this)를 인자로 함께 넘겨준다는 점입니다. 이것은 개별 thread에서 다른 thread로 메시지를 보낼 때, 이 Server클래스를 사용하여 메시지를 보낼 수 있도록 하기 위해서입니다. 즉 thread가 다른 모든 thread들의 레퍼런스를 가지고서 메시지를 보내는 것이 아니라 그냥 server에 메시지를 전송하도록 요청하면 서버는 목록에 있는 모든 클래스에게 메시지를 보내는 구조입니다. 아래 그림을 다시 보면 좀 이해가 빠를 듯합니다.


3) 서버 설계2: 리스트를 이용하여 모든 thread에 메시지 전송하기

그림에서 보면, 모든 thread에 메시지를 전송하는 메소드가 하나 더 필요하다는 것을 알 수 있죠. 이것의 구현은 아주 간단합니다. 그냥 for문으로 처음부터 끝까지 돌리면서 객체에 하나씩 하나씩 전송해주면 되죠.

public void message(String str) {
  for (int i=0; i<client.size(); i++) {
    ((ServerThread)client.elementAt(i)).sendMessage(str);
  }
}

client.elementAt(i)는 아까 만든 벡터에서 i째에 있는 객체니까, i번째에 만든 thread를 의미하겠죠. sendMessage(str)는 ServerThread에 구현해 놓은 메소드입니다. 이것을 호출하면 인자로 주어진 String을 자신이 연결된 클라이언트에 전송하게 됩니다. 이렇게 서버에서는 일일히 모든 클라이언트에 메시지를 전송하는 것이 아니라, 그냥 연결된 Thread에 있는 메소드를 호출하기만 하면, Thread가 알아서 메시지를 전송합니다. 위의 그림을 보면 이해가 쉬우리라 생각합니다.

 

그런데, 굵게 표시되어있는 (ServerThread)는 무엇인지 궁금할 것입니다. 이것은 클래스의 상속과 관계된 형변환입니다. 뒤에서 만들겠지만, 우리는 Thread 클래스를 상속하여 ServerThread를 작성할 것입니다. 자바의 모든 클래스는 Object라는 클래스에서 파생됩니다. Thread또한 마찬가지이고, 따라서 ServerThread 또한 Object로부터 파생된 것(Object를 상속한 것)입니다. SuperClass와 SubClass가 있을때, 좋은 용어는 아니지만, 부모 클래스와 자식클래스라고도 하죠. 아무튼 SuperClass를 상속하여 SubClass를 만들었다면, SuperClass로 선언된 변수는 자식 클래스를 받을 수 있습니다. 예를 들어, 다음 코드는 컴파일이 가능하다는 이야기죠.

Superclass s1=new Superclass();
Subclass s2=new Subclass();
s1=s2;

하지만, subclass s2가 s1에 넣어지면, s2가 새로 만든 메소드는 사용할 수 없게 됩니다. 즉, print()라는 메소드가 s2에만 있고, s1에만 있다면 s1=s2라고 s1에는 s2가 들어있지만, s1.print()와 같이 사용할 수 없다는 의미입니다. 따라서 print()메소드를 사용하기 위해서는 s1을 다시 s2로 형변환(type casting)을 해주어야 합니다. ((s2)s1).print()는 가능하다는 이야기입니다.

이런 이유로 위에서도 형변환이 필요합니다. 위에 있는 Vector클래스의 메소드들을 보면 알 수 있지만, addElement(Object obj)와 같이 컴포넌트를 추가할 때 Object로 받게 됩니다. 즉 벡터 안에서는 Object클래스로 변환되어 저장된다는 뜻입니다. elementAt()도 역시 Object로 반환합니다. Object클래스에 sendMessage()라는 메소드가 있을 리가 없죠. 따라서 반환된 클래스를 다시 처음대로 ServerThread로 만들어주기 위해서 앞에서와 같이 형변환을 하는 것이죠.


4) 서버 설계3: ServerThread구현

이 부분 또한 앞의 계산기 프로그램과 비슷합니다. 생성자에서 Server클래스를 인자로 받는 것과 sendMessage()메소드를 따로 구현해주어야 하는 차이점만 있습니다. 먼저 생성자를 만들어봅시다.

 

ChattingServer server=null;
BufferedReader br=null;
BufferedWriter bw=null;

public ServerThread(Socket socket, ChattingServer c) {
  server=c;
	
  try {
    br=new BufferedReader(new InputStreamReader(socket.getInputStream()));
    bw=new BufferedWriter(new OutputStreamWriter(socket.getOutputStream()));
  } catch (IOException e) {
  }
}

인자로 받은 ChattingServer클래스와 소켓을 클래스 내의 다른 메소드들이 쓸 수 있도록 클래스 인스턴스에 넣어줍니다. 다음에는 run()을 만들어주어야 합니다. 이미 알고 있겠지만, ChattingServer클래스에서 생성자를 사용하여 ServerThread를 만들고, start()를 사용하여 이 Thread를 구동시키면 run()메소드가 실행이 됩니다.

 

public void run() {
  String str="";

  while (true) {
    try {
      str=br.readLine();
      server.message(username+":"+str);
    } catch (IOException e) {
      server.removeClient(this);
      break;
    }
  }
}

 

아주 단순하죠? 그냥 한 줄을 읽어서, 그 내용 그대로 ChattingServer에 있는 message()메소드를 호출하였습니다. 앞에서 설명한 듯이 message()메소드에서는 리스트에 있는 모든 Thread들에게 클라이언트로 메시지를 보내라는 요청을 하게 되죠. 클라이언트로부터 데이터를 읽다가 exception이 나면 thread를 종료하도록 하였습니다. ChattingServer의 removeClient라는 메소드를 호출하도록 했네요. 이 메소드에서는 removeElement()를 사용해서 리스트에서 이 Thread를 제거하도록 하면 되겠죠. 그 구현은 각자에게 맡기겠습니다.

서버의 message()메소드를 호출하면 이 메소드에서는 각 thread에 있는 sendMessage(String str)을 호출하여 클라이언트에게 실제로 메시지를 전송하도록 하였던 것을 기억할 겁니다. sendMessage()메소드도 구현해주어야 하겠죠.

 

 

	public void sendMessage(String str) {
		try {
			bw.write(str);
			bw.newLine();
			bw.flush();
		} catch (IOException e) {
		}
	}

 

이렇게 하면 메시지를 클라이언트에 보낼 수 있게 됩니다. 이렇게 하면 ChattingServer가 일단 완성되었습니다. 하지만 채팅 프로그램에 꼭 필요한 기능들은 더 추가해야 합니다. 예컨대 사용자 이름을 어떻게든 받아서, 메시지를 보낼때마다 사용자 이름과 함께 보내도록 해야 하겠죠. 제가 테스트할 때는 클라이언트와 연결되면 클라이언트는 제일 먼저 사용자 이름을 전송하고, ServerThread에서는 그것을 받고 나서 루프를 돌도록 했습니다. 사실 이것은 그냥 클라이언트에서 자신의 이름을 처음부터 붙여서 전송하는 것도 괜찮겠죠.
제일 먼저 클라이언트가 접속을 하면 모든 사용자들에게 사용자가 들어왔다는 메시지를 전송하는 기능은 기본입니다. 또는 사용자 이름을 바꾸거나, 다른 사용자의 리스트를 보거나 하는 등의 기능들은 각자 추가해보시기 바랍니다.



5) 클라이언트1: 소켓 연결, 메시지 전송

소켓 연결과 메시지 전송은 따로 설명이 필요 없을 것 같네요. 그냥 소스만 보도록 하겠습니다.

 

Socket socket=null;
BufferedReader br=null;
BufferedWriter bw=null;

try {
	socket=new Socket(ip, port);
	br=new BufferedReader(new InputStreamReader(socket.getInputStream()));
	bw=new BufferedWriter(new OutputStreamWriter(socket.getOutputStream()));
	
} catch (IOException e) {
	System.out.println("Fail to connection!!");
	throw e;
}
		
ReceiveMessage r=new ReceiveMessage(br, this);
r.start();

 

다른 부분은 ReceiveMessage 를 선언해서 구동시키는 부분입니다. 이미 짐작했겠지만, ReceiveMessage는 Thread로 구현되어 있습니다. 이 부분은 앞에서 설명했듯이 계속해서 돌고 있다가 서버로부터 메시지를 받으면 클라이언트의 화면에 전송하는 역할을 합니다.

이번에는 실제와 비슷하게 클라이언트를 GUI로 만들도록 합니다. swing을 사용해서, TextArea와 TextField를 만들어서, TextField에 내용을 입력하면 서버에 전송하고, 서버로부터 메시지를 받으면 TextArea에 붙이도록 합니다. swing에 대한 자세한 내용은 Mahadevi의 Swing강좌를 참조하세요. 객체지향언어는 자료의 형식과 인자의 전달, 이벤트(메소드 호출)가 가장 중요하다고 할 수 있겠죠. 위 그림에서 클라이언트에서 사용자의 메시지를 기다리는 부분은 루프를 돌고 있는 것처럼 그려졌지만, 실제로는 이벤트에 의해서 일어납니다. TextField에 문자열을 입력하고 엔터를 치는 순간(이벤트가 발생하면) 메시지를 서버에 전송하게 되는 것이죠.

어떻게 텍스트필드를 달고 이벤트헨들링을 하는가에 대해서는 스윙이나 awt를 공부해야 하니까 여기서 설명을 하자면 한없이 길어질 것 같아서 생략해야 하겠네요. 아무튼 어떻게어떻게해서 텍스트 필드에서 데이터를 입력하면 sendMessage()라는 메소드가 실행되게 되었다고 칩시다. sendMessage()메소드에서는 텍스트 필드의 내용을 읽어서 서버에 전송하기만 하면 되겠죠.

 

public void sendMessage() {
  String str=textField.getText();   // 텍스트 필드의 내용을 얻는다.
  try {
    bw.write(str);                    // str을 버퍼에 넣는다.
    bw.newLine();                     // \n 을 추가한다.
    bw.flush();                       // 버퍼의 내용을 서버에 전송한다.
  } catch (IOException e) { 
    // 서버에 전송할 수 없는 상황을 처리할 수 있는 코드.
  }
}

 

이렇게 하면 클라이언트는 텍스트 필드에 내용을 입력하고서 엔터를 치면 서버로 전송할 수 있게됩니다.

6) 클라이언트2: 메시지 받기

ReceiveMessage 클래스를 만들어야겠군요. 이 클래스는 당연히 Thread로 작성되어야 하겠죠. 인자로는 데이터를 받아야 할테니까, 소켓 같은 것을 넣어주어야 하겠죠. 하지만 받기만 하니까 소켓 말고 BufferedReader를 넘겨주기로 합시다. 그리고 데이터를 받아서 화면에 써주어야 하는데, 이 화면은 ChattingClient클래스에 있는 것이니까 ReceiveMessage가 직접 쓸 수는 없겠죠. 그냥 편하게 Thread를 생성할때 ChattingClient가 자기 자신(this)을 넘겨주는 걸로 합시다. 나머지는 별다는 설명이 필요 없을 것 같으니까 그냥 소스를 봅시다.

 

class ReceiveMessage extends Thread {
	
	BufferedReader br=null;
	ChattingClient client=null;

	public ReceiveMessage(BufferedReader br, ChattingClient c) {
		this.client=c;
		this.br=br;
	}
	
	public void run() {
		
		String str="";
		
		while (true) {
			try {
				str=br.readLine();
				if (str!=null) {
					client.message(str);
				}
			} catch (IOException e) {
				
			}
				
		}	// end of while
	}	 // end of run ()
}  // end of class ReceiveMessage

 

소스는 매우 간단합니다. 생성자에서는 그냥 BufferedReader와 ChattingClient를 인자로 받기만 하고, run()메소드에서 무한 루프를 돌면서 한줄씩 받아서 ChattingClient의 message라는 메소드를 호출해주는 것이 다죠. 물론 ChattingClient에는 message()가 구현되어 있어야 하고, TextArea에 문자열을 출력해주는 일을 하겠죠.


7)참고 예제

제가 작성한 예제 화일입니다.

  • ChattingServer.java: 채팅 서버입니다. 컴파일 하시고, java ChattingServer [port-name/default=5777] 로 실행합니다.
  • ChattingClient.java: 클라이언트부입니다. 이것을 실행시키면 로컬호스트의 5777 포트로만 연결합니다. 이것 말고 아래의 RunClient를 실행시키세요.
  • RunClient.java: ChattingClient를 사용하여 실제 클라이언트 GUI를 만듭니다. java ChattingClient 라고 실행하면 ip와 port, username을 입력하는 창이 뜹니다.

먼저 서버를 실행시키시고, RunClient를 실행시키면 됩니다. IP입력창에서, 자신의 컴퓨터에 서버가 구동되고 있다면, 자신의 IP또는 127.0.0.1을 입력하시고, 다른 컴퓨터에서 실행된다면 그 컴퓨터의 IP를 입력하세요. port는 처음 서버를 구동시킬때 사용한 포트를 적어주어야 합니다. 별다른 옵션없이 서버를 구동했다면 포트번호는 5777번 입니다.

실제로 채팅 프로그램은 클라이언트가 애플릿일때 유용성이 클 것입니다. 하지만, 애플릿에서 소켓 통신을 하기 위해서는 보안정책파일을 편집해야 하기 때문에, 일단 그냥 어플리케이션으로 작성했습니다. ChattingClient가 JPanel로 작성되어있기 때문에 Applet으로 만들기 위해서는 애플릿을 상속한 적당한 클래스를 상속받아서 ChattingClient를 붙여주기만 하면 됩니다. 물론 보안정책파일도 편집해야 하겠죠.

"); // :script -->

이 포스트를..

덧글 쓰기 엮인글 쓰기

[object]’ 카테고리의 다른 글

[본문스크랩] 이클립스 Visual Editor 설치

2007/04/10

[본문스크랩] org.eclipse.swt.SWTException: Invalid thread access

2007/04/08

JFreeChart

2007/04/07

JAVA-SWT 프로그래밍 기초

2007/04/07

[본문스크랩] jni tutorial

2007/04/05

태그별 포스트 정보 보기 페이지 호출 -->

+ Recent posts