javadoc 보완 수정

src/main/java/cokr/xit/base/user/dao/UserMapper.java

@@ -16,15 +16,21 @@ import cokr.xit.foundation.data.DataObject;
 @Mapper("userMapper")
 public interface UserMapper extends AbstractMapper {
 	/**주어진 조건에 따라 사용자 목록을 조회하여 반환한다.<br />
+	 * {@link cokr.xit.base.user.service.UserService#getUserList(UserQuery)} 참고
 	 * @param req 사용자 조회 요청
-	 * <p>by는 조건필드
-	 * <ul><li>'userName' - 사용자 이름(디폴트)</li>
-	 *     <li>'userID' - 사용자 아이디</li>
-	 * </ul>
 	 * @return 사용자 목록
 	 */
 	List<DataObject> getUserList(UserQuery req);
 
+	/**지정한 아이디의 사용자 정보를 반환한다.
+	 * @param userID 사용자 아이디
+	 * @return 지정한 아이디의 사용자 정보
+	 */
+	default DataObject getUserInfo(String userID) {
+		List<DataObject> userList = getUserList(new UserQuery().setBy("userID").setTerm(userID));
+		return !userList.isEmpty() ? userList.get(0) : null;
+	}
+
 	/**지정한 아이디의 사용자들을 반환한다.
 	 * @param <T> 사용자 타입
 	 * @param req 사용자 아이디를 설정한 요청
@@ -34,7 +40,7 @@ public interface UserMapper extends AbstractMapper {
 
 	/**지정한 아이디의 사용자들을 반환한다.
 	 * @param <T> 사용자 타입
-	 * @param userID 사용자 아이디
+	 * @param userIDs 사용자 아이디
 	 * @return 사용자
 	 */
 	default <T extends User> List<T> getUsers(String... userIDs) {
@@ -92,11 +98,6 @@ public interface UserMapper extends AbstractMapper {
 
 	/**지정한 사용자들을 잠금 또는 잠김해제한다.
 	 * @param params 파라미터
-	 * <pre><code>{
-	 *     "userIDs":사용자 아이디 배열,
-	 *     "lock": 잠금 여부(true || false)
-	 * }</code></pre>
-	 * @param userIDs 사용자 아이디
 	 * @return 저장된 정보수
 	 */
 	int lockUsers(Map<String, ?> params);
@@ -119,10 +120,6 @@ public interface UserMapper extends AbstractMapper {
 
 	/**지정한 사용자의 상태를 설정한다.
 	 * @param params 파라미터
-	 * <pre><code>{
-	 *     "userIDs": 사용자 아이디 배열,
-	 *     "status": 사용자 상태(A, P, D)
-	 * }</code></pre>
 	 * @return 저장된 정보수
 	 */
 	int setStatus(Map<String, ?> params);

src/main/java/cokr/xit/base/user/package-info.java

@@ -1,5 +1,5 @@
 /**사용자 정보 관리 모듈.
- * <p><ul><li>사용자 클래스로 ManagedUser를 디폴트로 사용하고 있다.</li>
+ * <ul><li>사용자 클래스로 ManagedUser를 디폴트로 사용하고 있다.</li>
  *     <li>사용자 정보는 데이터베이스의 <a href="{@docRoot}/doc-files/xit-base-mysql.sql" target="_blank">TBL_USER 테이블</a>에 저장하여 관리한다</li>
  *     <li>사용자 클래스를 변경하려면
  *         <ul><li>변경하려는 사용자 정보 클래스를 선택하거나 새로 정의한다.</li>

src/main/java/cokr/xit/base/user/service/UserQuery.java

@@ -12,7 +12,7 @@ public class UserQuery extends QueryRequest {
 	private String[] userIDs;
 	private String status;
 
-	/**비밀번호 필드포함 여부를 반환한다.
+	/**조회 결과에 비밀번호 필드포함 여부를 반환한다.
 	 * @return 비밀번호 필드포함 여부
 	 * <ul><li>비밀번호 필드를 포함하려면 true</li>
 	 *     <li>그렇지 않으면 false</li>
@@ -22,14 +22,16 @@ public class UserQuery extends QueryRequest {
 		return password;
 	}
 
-	/**비밀번호 필드포함 여부를 설정한다.
+	/**조회 결과에 비밀번호 필드포함 여부를 설정한다.
 	 * @param password 비밀번호 필드포함 여부
 	 * <ul><li>비밀번호 필드를 포함하려면 true</li>
 	 *     <li>그렇지 않으면 false</li>
 	 * </ul>
+	 * @return UserQuery
 	 */
-	public void setPassword(boolean password) {
+	public <T extends UserQuery> T setPassword(boolean password) {
 		this.password = password;
+		return self();
 	}
 
 	/**사용자 아이디를 반환한다.
@@ -41,7 +43,7 @@ public class UserQuery extends QueryRequest {
 
 	/**사용자 아이디를 설정한다.
 	 * @param userIDs 사용자 아이디
-	 * @returns UserQuery
+	 * @return UserQuery
 	 */
 	public <T extends UserQuery> T setUserIDs(String... userIDs) {
 		this.userIDs = userIDs;
@@ -67,8 +69,10 @@ public class UserQuery extends QueryRequest {
 	 *     <li>'D' - 삭제</li>
 	 *     <li>지정하지 않으면 삭제되지 않은 전체 사용자</li>
 	 * </ul>
+	 * @return UserQuery
 	 */
-	public void setStatus(String status) {
+	public <T extends UserQuery> T setStatus(String status) {
 		this.status = status;
+		return self();
 	}
 }

src/main/java/cokr/xit/base/user/service/UserService.java

@@ -18,12 +18,33 @@ import cokr.xit.foundation.data.DataObject;
  * @author mjkhan
  */
 public interface UserService {
-	/**주어진 조건에 따라 사용자 목록을 조회하여 반환한다.<br />
-	 * @param req 사용자 조회 요청
+	/**주어진 조건에 따라 사용자 목록을 조회하여 반환한다.
+	 * @param req 사용자 조회 조건
+	 * <ul><li>by: 조건 필드 이름
+	 *     <ul><li>userID - 사용자 아이디</li>
+	 *         <li>그 외는 사용자 이름</li>
+	 *     </ul>
+	 *     </li>
+	 *     <li>term: 조건 필드값</li>
+	 *     <li>status: 상태 코드. 지정하지 않으면 삭제되지 않은 모든 사용자
+	 *     <ul><li>A - 신청</li>
+	 *         <li>P - 승인</li>
+	 *         <li>D - 삭제</li>
+	 *     </ul>
+	 *     </li>
+	 *     <li>pageNum: 페이지 번호</li>
+	 *     <li>fetchSize: 페이지 목록 건수</li>
+	 * </ul>
 	 * @return 사용자 목록
 	 */
 	List<DataObject> getUserList(UserQuery req);
 
+	/**지정한 아이디의 사용자 정보를 반환한다.<br />
+	 * @param userID 사용자 아이디
+	 * @return 사용자 정보
+	 */
+	DataObject getUserInfo(String userID);
+
 	/**지정한 아이디의 사용자들을 반환한다.
 	 * @param <T> 사용자 타입
 	 * @param userIDs 사용자 아이디

src/main/java/cokr/xit/base/user/service/bean/UserBean.java

@@ -24,11 +24,8 @@ public class UserBean extends AbstractComponent {
 	protected CharsEncoder passwordEncoder;
 
 	/**주어진 조건에 따라 사용자 목록을 조회하여 반환한다.<br />
-	 * @param req 사용자 조회 요청
-	 * <p>by는 조건필드
-	 * <ul><li>'userName' - 사용자 이름(디폴트)</li>
-	 *     <li>'userID' - 사용자 아이디</li>
-	 * </ul>
+	 * {@link cokr.xit.base.user.service.UserService#getUserList(UserQuery)} 참고
+	 * @param req 사용자 조회 조건
 	 * @return 사용자 목록
 	 */
 	public List<DataObject> getUserList(UserQuery req) {
@@ -40,6 +37,14 @@ public class UserBean extends AbstractComponent {
 		return userMapper.getUserList(req);
 	}
 
+	/**지정한 아이디의 사용자 정보를 반환한다.<br />
+	 * @param userID 사용자 아이디
+	 * @return 사용자 정보
+	 */
+	public DataObject getUserInfo(String userID) {
+		return userMapper.getUserInfo(userID);
+	}
+
 	/**지정한 아이디의 사용자들을 반환한다.
 	 * @param <T> 사용자 타입
 	 * @param userIDs 사용자 아이디
@@ -87,7 +92,7 @@ public class UserBean extends AbstractComponent {
 	 * </ul>
 	 */
 	public boolean update(User user) {
-		return user!= null ? userMapper.updateUser(user) > 0 : false;
+		return user!= null && userMapper.updateUser(user) > 0;
 	}
 
 	/**지정한 사용자들의 비밀번호를 변경한다. {@link cokr.xit.foundation.util.CharsEncoder 비밀번호는 암호화}하여 저장한다.

src/main/java/cokr/xit/base/user/service/bean/UserServiceBean.java

@@ -27,6 +27,11 @@ public class UserServiceBean extends AbstractServiceBean implements UserService
 		return userBean.getUserList(req);
 	}
 
+	@Override
+	public DataObject getUserInfo(String userID) {
+		return userBean.getUserInfo(userID);
+	}
+
 	@Override
 	public <T extends User> List<T> getUsers(String... userIDs) {
 		return userBean.getUsers(userIDs);

src/main/java/cokr/xit/base/user/web/UserController.java

@@ -27,8 +27,7 @@ public class UserController<U extends User> extends AbstractController {
 
 	/**사용자 관리 메인화면(user/user-main)을 연다.
 	 * 조건없는 {@link #getUserList(UserQuery) 사용자 조회 결과}를 포함시킨다.
-	 * @return ModelAndView
-	 *
+	 * @return base/user/user-main
 	 */
 	@RequestMapping(name="사용자 메인", value="/main.do")
 	public ModelAndView main() {
@@ -37,14 +36,15 @@ public class UserController<U extends User> extends AbstractController {
 		return mav.addObject("userList", toJson(mav.getModel().get("userList")));
 	}
 
-	/**{@link UserService#getUserList(UserQuery)} 참고.
-	 * @param req 사용자 조회 요청
+	/**사용자 목록을 조회하여 반환한다.<br />
+	 * {@link UserService#getUserList(UserQuery)} 참고
+	 * @param req 사용자 조회 조건
 	 * @return jsonView
 	 * <pre><code> {
-	 *     "userList": [...], // 사용자 목록
-	 *     "userStart": 0,    // 사용자 목록 시작 인덱스
-	 *     "userFetch": 10,   // 한 번에 가져오는 사용자 목록 수
-	 *     "userTotal":       // 조회 결과 찾은 전체 사용자 수
+	 *     "userList": [사용자 목록]
+	 *     "userStart": 사용자 목록 시작 인덱스
+	 *     "userFetch": 한 번에 가져오는 사용자 목록 수
+	 *     "userTotal": 조회 결과 찾은 전체 사용자 수
 	 * }</code></pre>
 	 */
 	@RequestMapping(name="사용자 조회", value="/list.do")
@@ -54,7 +54,11 @@ public class UserController<U extends User> extends AbstractController {
 	}
 
 	/**사용자 선택을 위한 화면을 연다.
-	 * @return "base/user/select-user"
+	 * @param multiple 여러 사용자 선택 여부
+	 * <ul><li>여러 사용자를 선택하려면 true</li>
+	 *     <li>그렇지 않으면 false</li>
+	 * </ul>
+	 * @return base/user/select-user
 	 */
 	@RequestMapping(name="사용자 선택", value="/select.do")
 	public ModelAndView select(boolean multiple) {
@@ -66,9 +70,9 @@ public class UserController<U extends User> extends AbstractController {
 
 	/**지정한 사용자 아이디가 사용 중인지 반환한다.
 	 * @param userID 사용자 아이디
-	 * @return
+	 * @return jsonView
 	 * <pre><code> {
-	 *     "duplicate": true || false // 사용 중이면 true, 그렇지 않으면 false
+	 *     "duplicate": 사용 중이면 true, 그렇지 않으면 false
 	 * }</code></pre>
 	 */
 	@RequestMapping(name="중복 확인", value="/duplicate.do")
@@ -80,19 +84,15 @@ public class UserController<U extends User> extends AbstractController {
 
 	/**지정한 아이디의 사용자 정보를 반환한다.
 	 * @param userID 사용자 아이디
-	 * @return jsonView
+	 * @return base/user/user-info 또는 jsonView
 	 * <pre>{
-	 *     "userInfo": 사용자 정보(map)
+	 *     "userInfo": 사용자 정보
 	 * }</pre>
 	 */
 	@RequestMapping(name="사용자 정보 조회", value="/info.do")
 	public ModelAndView getInfo(String userID) {
 		if (!isEmpty(userID)) {
-			UserQuery req = new UserQuery()
-				.setBy("userID")
-				.setTerm(userID);
-			List<DataObject> userList = userService.getUserList(req);
-			DataObject userInfo = !userList.isEmpty() ? userList.get(0) : null;
+			DataObject userInfo = userService.getUserInfo(userID);
 			boolean json = jsonResponse();
 			return new ModelAndView(json ? "jsonView" : "base/user/user-info")
 				.addObject("userInfo", json ? userInfo : toJson(userInfo));
@@ -103,9 +103,9 @@ public class UserController<U extends User> extends AbstractController {
 
 	/**사용자를 등록한다.
 	 * @param user 사용자 정보
-	 * @return
+	 * @return jsonView
 	 * <pre><code> {
-	 *     "saved": true || false // 저장되었으면 true, 그렇지 않으면 false
+	 *     "saved": 등록되었으면 true, 그렇지 않으면 false
 	 * }</code></pre>
 	 */
 	@PostMapping(name="사용자 등록", value="/create.do")
@@ -117,9 +117,9 @@ public class UserController<U extends User> extends AbstractController {
 
 	/**사용자 정보를 수정한다.
 	 * @param user 사용자 정보
-	 * @return
+	 * @return jsonView
 	 * <pre><code> {
-	 *     "saved": true || false // 저장되었으면 true, 그렇지 않으면 false
+	 *     "saved": 수정되었으면 true, 그렇지 않으면 false
 	 * }</code></pre>
 	 */
 	@PostMapping(name="사용자 수정", value="/update.do")
@@ -132,10 +132,10 @@ public class UserController<U extends User> extends AbstractController {
 	/**사용자 비밀번호를 변경한다.
 	 * @param userID 사용자 아이디
 	 * @param password 비밀번호
-	 * @return
+	 * @return jsonView
 	 * <pre><code> {
-	 *     "affected": 1, // 저장된 정보수
-	 *     "saved": true || false // 저장되었으면 true, 그렇지 않으면 false
+	 *     "affected": 저장된 정보수,
+	 *     "saved": 저장되었으면 true, 그렇지 않으면 false
 	 * }</code></pre>
 	 */
 	@PostMapping(name="비밀번호 변경", value="/changePassword.do")
@@ -148,10 +148,10 @@ public class UserController<U extends User> extends AbstractController {
 
 	/**사용자 가입신청을 승인한다.
 	 * @param userIDs 사용자 아이디
-	 * @return
+	 * @return jsonView
 	 * <pre><code> {
-	 *     "affected": 1, // 저장된 정보수
-	 *     "saved": true || false // 저장되었으면 true, 그렇지 않으면 false
+	 *     "affected": 저장된 정보수
+	 *     "saved": 저장되었으면 true, 그렇지 않으면 false
 	 * }</code></pre>
 	 */
 	@PostMapping(name="사용자 가입 승인", value="/approve.do")
@@ -163,12 +163,15 @@ public class UserController<U extends User> extends AbstractController {
 	}
 
 	/**사용자 잠금이나 잠금해제를 수행한다.
-	 * @param lock 잠금 여부(잠그면 true, 잠금을 해제하면 false)
+	 * @param lock 잠금 여부
+	 * <ul><li>잠금이면 true</li>
+	 *     <li>잠금을 해제하면 false</li>
+	 * </ul>
 	 * @param userIDs 사용자 아이디
-	 * @return
+	 * @return jsonView
 	 * <pre><code> {
-	 *     "affected": 1, // 저장된 정보수
-	 *     "saved": true || false // 저장되었으면 true, 그렇지 않으면 false
+	 *     "affected": 저장된 정보수
+	 *     "saved": 저장되었으면 true, 그렇지 않으면 false
 	 * }</code></pre>
 	 */
 	@PostMapping(name="사용자 잠김/잠김해제", value="/unlock.do")
@@ -181,10 +184,10 @@ public class UserController<U extends User> extends AbstractController {
 
 	/**지정한 사용자를 제거한다.
 	 * @param userIDs 사용자 아이디
-	 * @return
+	 * @return jsonView
 	 * <pre><code> {
-	 *     "affected": 1, // 저장된 정보수
-	 *     "saved": true || false // 저장되었으면 true, 그렇지 않으면 false
+	 *     "affected": 저장된 정보수
+	 *     "saved": 저장되었으면 true, 그렇지 않으면 false
 	 * }</code></pre>
 	 */
 	@PostMapping(name="사용자 제거", value="/remove.do")