wolfboys commented on code in PR #1831: URL: https://github.com/apache/incubator-streampark/pull/1831#discussion_r996378736
########## streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/entity/Variable.java: ########## @@ -0,0 +1,65 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.streampark.console.system.entity; + +import com.baomidou.mybatisplus.annotation.IdType; +import com.baomidou.mybatisplus.annotation.TableId; +import com.baomidou.mybatisplus.annotation.TableName; +import lombok.Data; + +import javax.validation.constraints.NotBlank; +import javax.validation.constraints.NotNull; +import javax.validation.constraints.Size; + +import java.io.Serializable; +import java.util.Date; + +@Data +@TableName("t_variable") +public class Variable implements Serializable { + + private static final long serialVersionUID = -7720746591258904369L; + + @TableId(type = IdType.AUTO) + private Long id; + + @NotBlank(message = "{required}") + private String variableCode; + + @NotBlank(message = "{required}") + @Size(max = 50, message = "{noMoreThan}") + private String variableValue; + + @Size(max = 100, message = "{noMoreThan}") + private String description; + + private Long creator; Review Comment: > 一个好的名字应该描述意图，而非细节。 摘选自极客时间专栏《代码之丑》 > >  hi fanrui: The "entity" package name is all the entities corresponding to the table. The user_id is easier to identify and recognize at the level of data model design. "creator" is difficult for me to know the creator's name or the creator's id, or anyone else's information , meaning unclear. It is also difficult to generate a complete association, the problem is that this is a specification problem. If this one is changed, other more fields such as: role_id, menu_id, team_id can be found everywhere in other tables, How should you name it? And these are the best practices and established habits of the java back-end, and it is not recommended to modify them. ---- entity包名下放的全是和表对应的实体, user_id 站在数据模型设计的层面更容易辨认和识别, creator 单看名字我很难知道是创建者名字还是创建者id, 还是其他任何人的信息, 表达的意思很迷糊. 也很难产生完整的联想, 问题是这是一个规范问题.如果这一处更改了, 其他的更多字段如: role_id, menu_id, team_id 在其他表中比比皆是,你该怎么命名? 而且这些是中台体系沉淀下来的最佳实践, 约定俗成的习惯, 不建议修改. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
