单一职责原则什么时候方法可以接受多种类型的数据?

Single Responsibility Principle when method can accept various types of data?

最佳实践建议一个方法或函数应该做一件事,并且把它做好,那么我如何在以下场景中应用 SRP:

总结:我有一个 API 包装器,它发送一个 HTTP Post 请求,但是为了提供 json 我想允许用户多个选项,让我说我的函数可以接受以下任何一项:

def function_for_srp(jsonable_data: Union[Entity, Domain, str]):
    # Pseudo code (Violation of SRP?)
    if jsonable_data is instance of entity or domain:
        jsonable_data = json.dumps(jsonable_data) 
    else do nothing, as its a json encoded string of data already
    some_api_wrapper.post_data(jsonable_data) 

这个函数根据传递给它的数据类型做很多事情,所以它违反了 SRP?我如何以干净的方式克服这个设计问题,理想情况下我在想这样的事情:

def function_for_srp_using_entity(entity: Entity): pass
def function_for_srp_using_domain(domain: Domain): pass
def function_for_srp(json_encoded_data: str): pass

上面是'pythonic'吗? 有更好的方法吗?

# possible alternative?
def function_for_srp(jsonable_data: Union[Entity, Domain, str]):
    json = some_other_function(jsonable_data)
    some_api_wrapper.post_something(json)
    # Is this still a violation?

def some_other_function(jsonable_data: Union[Entity, Domain, str]):
    # Figure out the type and return a json encoded string that is suitable
    if isinstance of entity/domain, json dump and return
    else check if is valid json encoded string, if not make it valid and return it

SRP 绝对是一个值得遵循的重要原则,但在实践中,您需要知道何时划清界线,否则会给您的代码增加太多的复杂性。

在您的具体情况下,我会从对您的用户更好的方面着手,然后决定您是否保留此

def function_for_srp(jsonable_data: Union[Entity, Domain, str]):

def function_for_srp_using_entity(entity: Entity): pass
def function_for_srp_using_domain(domain: Domain): pass

第二个选项很明确,你没有违反任何原则:)

如果您想保留第一个选项,您可以这样做(也 pseudo-code):

def function_for_srp(jsonable_data: Union[Entity, Domain, str]):
jsonableData = jsonable_data.getjson(); 
some_api_wrapper.post_data(jsonable_data) 

您可以根据需要实现 getJson(作为 Entity 上的函数和 Domain 之外的单独函数。 这会给你更清晰的单元测试,但在你的特定情况下,你可以决定保持原样而不是 over-engineering 它。 KISS也是一个很好的原则