diff --git a/app/src/main/java/com/example/musicplayer/entiy/SearchHistory.java b/app/src/main/java/com/example/musicplayer/entiy/SearchHistory.java index f19eb3d..6003915 100644 --- a/app/src/main/java/com/example/musicplayer/entiy/SearchHistory.java +++ b/app/src/main/java/com/example/musicplayer/entiy/SearchHistory.java @@ -3,26 +3,68 @@ package com.example.musicplayer.entiy; import org.litepal.crud.LitePalSupport; /** - * Created by 残渊 on 2018/11/29. + *
+ *     author : 残渊
+ *     time   : 2018/11/29
+ *     desc   : 该类用于表示搜索历史的相关信息实体,旨在记录用户在音乐播放器中进行搜索操作时输入的关键词等历史信息,
+ *              方便后续根据这些搜索历史实现一些功能,比如提供搜索历史记录列表方便用户快速再次搜索,或者基于历史搜索内容进行数据分析等。
+ * 
*/ - +// SearchHistory类继承自LitePalSupport类,借助LitePal框架提供的功能,可以方便地与数据库进行交互, +// 例如将搜索历史信息持久化存储到数据库中,以便后续能从数据库里查询特定的搜索历史记录、更新已有记录的内容, +// 或者根据业务需求删除某些不再需要的搜索历史记录等,有助于高效地管理用户的搜索历史数据。 public class SearchHistory extends LitePalSupport { + /** + * 用于存储用户曾经输入的具体搜索内容,也就是搜索历史信息,以字符串的形式记录下来, + * 例如用户输入过“周杰伦的歌曲”进行搜索,那么这个字符串“周杰伦的歌曲”就会被存储在此变量中, + * 方便后续展示给用户查看,或者依据它再次发起类似的搜索操作等。 + */ String history; + /** + * 用于唯一标识每一条搜索历史记录的标识符,在数据库存储中充当主键的角色, + * 每一次用户的搜索操作记录在数据库里都会有一个与之对应的唯一整数值,通过这个值能够精准地定位、查询、修改或者删除对应的搜索历史记录, + * 通常该主键值由数据库按照自增等既定规则自动生成,以此保证每条搜索历史记录都能被准确区分和操作,便于数据库层面的高效管理。 + */ int id; + /** + * 获取存储的搜索历史信息(即用户曾经输入的搜索内容)的方法,外部代码通过调用此方法, + * 能够获取到一个字符串,该字符串就是对应的搜索历史记录的具体内容,在展示搜索历史列表、 + * 根据历史记录再次发起搜索等业务场景中,这个方法提供了获取搜索历史内容的途径,方便进行相应的操作。 + * @return 返回表示搜索历史内容的字符串。 + */ public String getHistory() { return history; } + /** + * 设置搜索历史信息的方法,当需要更新某条搜索历史记录的内容(比如最初记录有误、用户手动修改了历史记录等情况)时, + * 外部代码可以通过传入一个新的字符串作为参数,来更新当前SearchHistory对象中的搜索历史属性, + * 确保搜索历史信息的准确性和及时性,便于后续正确使用这些历史记录。 + * @param history 要设置的表示搜索历史内容的字符串。 + */ public void setHistory(String history) { this.history = history; } + /** + * 获取当前搜索历史记录在数据库中的唯一标识(主键)的方法,外部代码调用此方法, + * 能够获取到一个整数值,该值可用于在数据库相关操作(如查询、更新、删除该搜索历史记录等)中准确地定位到对应的记录, + * 保证数据库操作的准确性和针对性,是对搜索历史记录进行数据库层面操作的关键入口之一。 + * @return 返回表示搜索历史记录主键的整数值。 + */ public int getId() { return id; } + /** + * 设置当前搜索历史记录在数据库中的唯一标识(主键)的方法,不过一般情况下, + * 这个主键值由数据库自动管理和分配,很少会被外部代码直接调用修改, + * 只有在特定的业务场景下(如数据迁移过程中需要手动调整主键值、数据库记录出现异常需要修正主键等情况)才会使用, + * 通过传入一个合法的整数值来更新当前SearchHistory对象的主键信息。 + * @param id 要设置的表示搜索历史记录主键的整数值。 + */ public void setId(int id) { this.id = id; } -} +} \ No newline at end of file