实体定义

无论是高级查询还是基础查询，都会需要一个表实体。一个表字段和一个类属性是一一映射，对类的操作相当于对表的操作，该类称为一个实体

  • 一个实体类对应一张数据库的表结构
  • 实体对象代表了表的一行数据记录

注意： 实体不能作为属性被注入到任何类, 因为每个实体对象都是不同的数据记录行。实体对象都是在哪用就在哪里创建它。

注解标签

@Entity

标记一个类是一个实体，无需多余参数

参数：

  • instance 定义实体对应实例，默认 default 实例 对，就是前面配置上的那个default实例:)

若需使用基础查询，必须继承Model

@Table

  • name 定义该实体映射的数据库表名

@Column

参数：

  • name 定义类属性映射的表字段，没该注解标记的属性，不映射
  • type 定义字段数据更新时验证类型，暂时提供常见的数据类型延迟，后续会更多

说明：

  • 若定义type，可定义其它验证条件
  • 所有字段属性，必须要有getter和setter方法

类属性默认值即是表字段默认值

@Id

该注解标明当前类属性对应了数据库表中的主键，必须有这个注解标记

快速生成实体类

swoft 提供了内置命令帮助快速生成实体类。

  1. php bin/swoft entity:create -d dbname mytable,table2

更多使用信息请查看 命令创建实体 或者使用 -h 查看命令帮助信息

示例

  1. /**
  2.  * @Entity()
  3.  * @Table(name="user")
  4.  */
  5. class User extends Model
  6. {
  7.     /**
  8.      * 主键ID
  9.      *
  10.      * @Id()
  11.      * @Column(name="id", type=Types::INT)
  12.      * @var null|int
  13.      */
  14.     private $id;
  16.     /**
  17.      * 名称
  18.      *
  19.      * @Column(name="name", type=Types::STRING, length=20)
  20.      * @Required()
  21.      * @var null|string
  22.      */
  23.     private $name;
  25.     /**
  26.      * 年龄
  27.      *
  28.      * @Column(name="age", type=Types::INT)
  29.      * @var int
  30.      */
  31.     private $age = 0;
  33.     /**
  34.      * 性别
  35.      *
  36.      * @Column(name="sex", type="int")
  37.      * @var int
  38.      */
  39.     private $sex = 0;
  41.     /**
  42.      * 描述
  43.      *
  44.      * @Column(name="description", type="string")
  45.      * @var string
  46.      */
  47.     private $desc = "";
  49.     /**
  50.      * 非数据库字段，未定义映射关系
  51.      *
  52.      * @var mixed
  53.      */
  54.     private $otherProperty;
  56.     /**
  57.      * @return int|null
  58.      */
  59.     public function getId()
  60.     {
  61.         return $this->id;
  62.     }
  64.     /**
  65.      * @param int|null $id
  66.      */
  67.     public function setId($id)
  68.     {
  69.         $this->id = $id;
  70.     }
  72.     /**
  73.      * @return null|string
  74.      */
  75.     public function getName()
  76.     {
  77.         return $this->name;
  78.     }
  80.     /**
  81.      * @param null|string $name
  82.      */
  83.     public function setName($name)
  84.     {
  85.         $this->name = $name;
  86.     }
  88.     /**
  89.      * @return int
  90.      */
  91.     public function getAge(): int
  92.     {
  93.         return $this->age;
  94.     }
  96.     /**
  97.      * @param int $age
  98.      */
  99.     public function setAge(int $age)
  100.     {
  101.         $this->age = $age;
  102.     }
  104.     /**
  105.      * @return int
  106.      */
  107.     public function getSex(): int
  108.     {
  109.         return $this->sex;
  110.     }
  112.     /**
  113.      * @param int $sex
  114.      */
  115.     public function setSex(int $sex)
  116.     {
  117.         $this->sex = $sex;
  118.     }
  120.     /**
  121.      * @return string
  122.      */
  123.     public function getDesc(): string
  124.     {
  125.         return $this->desc;
  126.     }
  128.     /**
  129.      * @param string $desc
  130.      */
  131.     public function setDesc(string $desc)
  132.     {
  133.         $this->desc = $desc;
  134.     }
  136.     /**
  137.      * @return mixed
  138.      */
  139.     public function getOtherProperty()
  140.     {
  141.         return $this->otherProperty;
  142.     }
  144.     /**
  145.      * @param mixed $otherProperty
  146.      */
  147.     public function setOtherProperty($otherProperty)
  148.     {
  149.         $this->otherProperty = $otherProperty;
  150.     }
  151. }