编码规范 - 养成良好的Java编码习惯

/**
 * 统一资源Aop切面定义
 * 根据自定义注解配置自动设置配置的资源类型到指定的字段
 * @author：于起宇 <br/>
 * ===============================
 * Created with IDEA.
 * Date：2017/12/15
 * Time：14:05
 * ================================
 */

/**
 * 资源处理业务逻辑
 */
Autowired
ResourcePushService resourcePushService;

    /**
     * 资源设置切面方法
     * 拦截配置了@ResourceMethod注解的class method
     * cglib仅支持class 方法切面，接口切面不支持
     * @param proceedingJoinPoint 切面方法实例
     * @param resourceMethod 方法注解实例
     * @return 原方法返回对象
     */
    @Around(value = "@annotation(resourceMethod)")
    public Object resourcePutAround(ProceedingJoinPoint proceedingJoinPoint, ResourceMethod resourceMethod)
        throws Throwable
    {
        //...
    }

    /**
     * 创建帖子
     * - 转换参数实体为
     * - 保存帖子基本信息
     * @param param 创建帖子请求参数实体
     * @return 帖子编号
     * @throws LogicException
     */
    public String create(CreateTopicParam param) throws LogicException {
        //...
    }

// 执行方法，获取返回值

/*
 * 执行方法，获取返回值
 * 获取返回值进行后续逻辑处理
 */

/**
 * 帖子列表数据转换实体
 * @author：于起宇 <br/>
 * ===============================
 * Created with IDEA.
 * Date：2018/1/8
 * Time：10:52
 * ================================
 */
@Data
public class TopicListDTO
        extends CommunicationTopicInfoEntity {

    /**
     * 用户昵称
     */
    private String userNickName;
    /**
     * 所属机构名称
     */
    private String orgName;
    //...
}

/**
 * 查询帖子列表
 * - 用于查询自己、他人、关键字、首页帖子请求参数
 *
 * @author：于起宇 <br/>
 * ===============================
 * Created with IDEA.
 * Date：2018/1/8
 * Time：10:31
 * ================================
 */
@Data
public class SelectTopicParam extends PagerParam {
    /**
     * 用户编号
     */
    private String userId;
    /**
     * 查询关键字
     */
    @Length(max = 30)
    private String keyWord;
}

_name / name_ / $name / name$ / __name / name__

WenZhang[文章] / WenZhangInfo[文章信息] / getTopicLieBiao()[获取文章列表] / int 数量 = 0

QRCode / UserInfoDto / XMLService

QrCode / UserInfoDTO / XmlService

localvalue / GetUserInfo() / userid

localValue / getUserInfo() / userId

MAX_COUNT / NAME

MAX_STOCK_COUNT / DEFAULT_ORG_NAME

AbstractCodeMessageService / BaseCodeMessageService / LogicException / UserControllerTest

com.sanmi.framework.core / com.sanmi.framework.orm

AbstractClass = > AbsClass
condition => condi

public abstract void commit();

void commin(); / String COMPANY_NAME = "sanmi";

UserInfoService / UserInfoServiceImpl

枚举名称 => UserStatusEnum
成员名称 => ENABLE / DISABLED / DELETE

if("enable".equals(user.getStatus())) { 
   //.. 
}

Integer => int
Double => double
Long => long
...

@Getter
public enum  UserBzEnum
{
    /**
     * 普通用户
     */
    APP_USER("0"),
    /**
     * 月嫂
     */
    NANNY("1"),
    /**
     * 医生
     */
    DOCTOR("2")
    ;
    private String value;

    UserBzEnum(String value) {
        this.value = value;
    }
}

if ( a == b )

 if (ValidateTools.isEmpty(uploadBackEntity) || ValidateTools.isEmpty(uploadBackEntity.getUploadUrl())) {
 //...
        }

// 定义用户名
String userName = user.getName();

StringBuffer buffer = new StringBuffer();
// 超过120个字符的情况下，换行缩进4个空格，``.``和方法名一块换行
buffer.append("san").append("mi") ...
        .append("ke")
        .append("ji");
// 参数过多超120个字符时，在 , 后换行
method(args1, args2, args3, ...
args98, args99
)        

method(args1, args2);

object.equals("test");

"test".equals(object)

List<String< list = new ArrayList();
list.add("jinan");
list.add("sanmi");
// 生成list长度的数组实例
String[] array = new String[list.size()];
// 执行集合转换数据
array = list.toArray(array);

Iterator<String> iterator = list.iterator();
while (iterator.hasNext()) {
    String item = iterator.next();
    if (condition) {
        iterator.remove();
    }
}

if (condition) statements;

if (condition) {
    statements;
}

if (condition) {
    //...
    return object;
}
// 继续处理 else / else if 业务逻辑代码

public void today() {
    if (isBuy()) {
        System.out.println("do something.");
        return;
    }
    if (isFree()) {
        System.out.println("do something.");
        return;
    }
    System.out.println("coding..");
}

// 直接使用不确定对象
object.setXxx(value);

// 判断非空后使用不确定对象
if (object != null) {
    //...
}

if (condition) {
    throw new LogicException(ErrorCodeEnum.USER_NOT_FOUND);
}

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
// 获取日志对象
private static final Logger logger = LoggerFactory.getLogger(Xxx.class);

logger.debug("执行查询用户：{}，基本信息。",user.getId());

public void today(String userId) {
    logger.debug("查询用户：{}，今日任务完成进度",userId);
}

if (condition1) {
    logger.debug("do something.");
} else if (condition2) {
    logger.debug("do other thing.");
}

logger.error(参数或对象.toString() + "_" + e.getMessage(), e);