[개발철학] Simple more Simple

단순명료(單純明瞭)함.

  나의 개발철학은 이 한마디로 정리할 수 있을 듯 하다. 다른 이들이 보아도 나의 개발철학은 단순명료함을 유지하여 적은 시간을 투자하여 빠른 이해와 높은 활용성을 얻도록 하는 것을 목적으로 하고 있다. 나와 동문수학한 다른 이들을 도와주기 위해 그들이 작성한 코드를 가만히 들여보고 있자면, 한숨이 절로 나오는 경우가 있다. 자신이 지정한 변수가 어떤 타입인지 모르고 전혀 엉뚱한 타입으로 받아서 생기는 오류(이클립스와 같은 IDE 툴을 사용하는데도 종종 볼 수 있었다)에서 시작해서 자신이 생각해낸 알고리즘이 아니라, 단순히 인터넷 검색을 통해 나와있는 코드를 그대로 복사해서 붙이면서 발생한 이해불능의 기능으로 인해서 읽기 어려움에 빠진다. 그것을 보면서 나는 저렇게 해서는 안되겠다는 생각을 다짐하고 또 다짐했다. 그와 동시에 이런 나의 생각을 내 개발습관 속에 서서히 녹아들도록 만들었다. 철저하게 코딩스타일을 유지하며 낯설은 부분에서는 이해하기 쉽도록 주석을 첨가하고, 가급적이면 한줄에 하나의 명령어만을 구현하도록 노력했다. 코드는 자기가 봤을 때도 이해하기 쉽고 다른 사람이 봤을 때도 이해하기 쉽게 만들어져야 한다.

   C언어를 배우는 초기에는 컴퓨터의 제약조건들 때문에 한줄에도 많은 명령어를 구현하려고 노력했었다. 하지만, 지금에 와서 PC의 성농은 비약적으로 증가되었으며, 객체지향언어가 발달하고 널리 사용되면서 굳이 적은 코드파일 크기를 고집할 필요성이 약해지고 있다. 이런 상황에서 나는 코드의 가독성과 이해력을 높이기 위해서라면, 한 줄로 끝날 계산도 가급적이면 나누고 나누어서 표현을 하려고 노력한다. 그것이 나의 Simple more Simple 개발철학이다. 이런 나의 개발철학은 나의 개발물들을 후에 다른 사람들이 수정할 일이 생겼을 때 수정하여 사용하기 쉽도록 하여 내 코드의 재활용성을 높여줄 것이다.

  간혹 프리랜서로 일한 사람들의 코드를 보면 쉽게 이해할 수 없는 부분들이 많은 경우가 있다. 이에 대한 문서화도 제대로 되지 않아서 급하게 수정해야할 경우 난해한 경우가 생긴다. 프리랜서로서 그렇게 해야 다시 자신들을 불러줄 거라고 생각하는지 모르겠지만, 개인적으로 그런 습관을 가지고 있는 프리랜서라면 나는 다시는 안 쓴다.  깔끔하고 이해하기 쉬운 코딩스타일을 가지고 있으면서 문서화를 잘하는 프로그래머와 계속 함께 일하고 싶어할 거니까. 나 역시 그런 프로그래머가 되려고 노력할 것이다.

이 글은 스프링노트에서 작성되었습니다.

기본적인 암호화 처리를 해주는 메소드를 살짝 변경하였습니다.  암호화키를 저장해주지 못하기 때문에 별도의 페이지에서는 사용이 어려웠음.

필요하시면, 가져다 쓰셔도 됩니다. ^^ 암호화된 코드에다가 자기만의 암호화 처리 방법을 넣어서 해주시면 좋습니다. +_+)b

JSP에서 처리할 경우에는 returnEncryptCode(String str)에서 반환된 문자열을 저장하는 문자열 혹은 객체를 저장하는 방법만 고려하면 되겠다.

1. package encrypt;
   
   import java.io.ByteArrayInputStream;
   import java.io.ByteArrayOutputStream;
   import java.io.IOException;
   import java.io.ObjectInputStream;
   import java.io.ObjectOutputStream;
   import java.security.InvalidKeyException;
   import java.security.Key;
   
   import javax.crypto.BadPaddingException;
   import javax.crypto.Cipher;
   import javax.crypto.IllegalBlockSizeException;
   import javax.crypto.KeyGenerator;
   
   import sun.misc.BASE64Decoder;
   import sun.misc.BASE64Encoder;
    
   public class LocalEncrypter{
       //DESede 는 암호화시 사용되는 최대 키 사이즈를 지정하는 키워드임 : 관련페이지 내용 링크
2.     private static String algorithm = "DESede";
       private static Key    key       = null;
       private static Cipher cipher    = null;
    
      
       // 암호화 키를 발생시키는 메소드입니다.
       // com.sun.crypto.provider.DESedeKey@ + 16진수 8자리
       public LocalEncrypter() throws Exception {
           key = KeyGenerator.getInstance( algorithm ).generateKey();
          
   //        private static String keystr = String.valueOf(key);
   //        System.out.println(key);
   //        System.out.println("암호화 키의 형태 :"+ keystr);
   //        System.out.println(keystr.length());
          
           cipher = Cipher.getInstance( algorithm );   
       }
      
      
       //1. str 을 입력 받아서 이를 암호한다.    //2. 암호화 하는데 사용한 암호키를 encKey 로 문자열화 한다.
       //3. encKey + str 값을 반환한다. 크기는 408 byte
       public  static String returnEncryptCode(String str) throws Exception {
           byte [] encryptionBytes = null;
    
   
           // 입력받은 문자열을 암호화 하는 부분
           encryptionBytes = encrypt( str );
           BASE64Encoder encoder = new BASE64Encoder();
   
           //encoder.encode(encryptionBytes) 으로 encrypt 된 값 출력
           String encodeString = encoder.encode(encryptionBytes);
          
           // 키를 문자열로 바꿔주는 곳.
           ByteArrayOutputStream bos = new ByteArrayOutputStream();
           ObjectOutputStream oos = new ObjectOutputStream(bos);
           oos.writeObject(key);
           oos.close();
           BASE64Encoder b64enc = new BASE64Encoder();
           byte[] keyArr = bos.toByteArray();
           String encKey = b64enc.encode(keyArr);   
          
   //        System.out.println("문자열이 되어 저장된 키 : " + encKey);
   //        System.out.println("저장된 키의 길이 : " + encKey.length());
   //        System.out.println("암호화된 비밀번호 : " + encodeString);
   
   
   /*                // 암호화에 사용된 키값을 뽑아낸 수
            String keycode = keystr.substring(34,42);
            System.out.println("암호화에 사용된 키 : " + keycode);
            String randomcode = returnRandomCode();
            System.out.println("암호화된 코드 : " + encodeString);*/
           
           return encKey + encodeString;
       }
   
      
       //1. DB에 저장되어 있는 408 byte 길이의 str을 받는다.
       //2. 그중 0~384 까지의 암호화키(encKey)부분을 keycode로 뽑아낸다.
       //3. keycode를 Key에 대입한다.
       //4. 384~408 까지의 암호화된 문자열을 code로 뽑아낸다.
       //5. code를 해독한다.
       //6. 해독된 값을 반환한다.
       public String returnDecryptCode(String str) throws Exception {
           //복호화 하기 위해서는 암호화 키가 필요하다. ㅡㅅ-);;
           // 그래서 생각해낸 것이, DB에 저장될 때, 암호화키를 한번에 집어넣고....
           //substring 으로 잘라서 쓰는 것.
           int strLength = str.length();
          
           //암호화된 비밀번호에 저장되어 있는 암호화키를 추출.
              String keycode = str.substring(0,384);
             
             
              // 추출한 암호키를 KEY 형태로 다시 복구
              BASE64Decoder b64dec = new BASE64Decoder();
              byte[] b = b64dec.decodeBuffer(keycode);
              ByteArrayInputStream bis = new ByteArrayInputStream(b);
              ObjectInputStream ois = new ObjectInputStream(bis);
              key = (Key) ois.readObject();
              ois.close();
             
           String code = str.substring(384, strLength);
          
             
   //        System.out.println("저장된 코드 길이 : " + strLength);
   //           System.out.println("암호화 사용키 : " + keycode);
   //        System.out.println("암호화된 코드: " + code);
          
           BASE64Decoder decoder = new BASE64Decoder();
           String decode = decrypt( decoder.decodeBuffer(code));
          
   //        System.out.println("Ecrypt 에서 해독한 것 : " + decode);
           return decode;
       }
      
    
      
       // encryptionBytes = encrypt( input ), input을 변조하여 encryptionBytes에 대입함.
       private static byte [] encrypt(String input) throws InvalidKeyException, BadPaddingException, IllegalBlockSizeException  {
           cipher.init( Cipher.ENCRYPT_MODE, key );
           byte [] inputBytes = input.getBytes();
           return cipher.doFinal( inputBytes );
       }
    
      
      
       //decrypt( decoder.decodeBuffer(encodeString) ) 처리부분.
       private static String decrypt(byte [] encryptionBytes) throws InvalidKeyException, BadPaddingException, IllegalBlockSizeException{
           cipher.init( Cipher.DECRYPT_MODE, key);
           byte [] recoveredBytes = cipher.doFinal( encryptionBytes );
           String recovered = new String( recoveredBytes );
           return recovered;
       }
    
   }

이 글은 스프링노트에서 작성되었습니다.