В PHP канонично сначала проверить, потом сделать или попробовать и обработать ошибку?

Question

[Олег Правдин]

Собственно, сабж. Try - Catch или все необходимые проверки перед выполнением кода?
UPD: пример. Что по идеологии подходит к PHP? (примеры на псевдокоде)

# Вариант 1:
f getFileContent(filename){
if (!file_exists(filename)) {error: file not found}
return file_content(filename)
}

# Вариант 2:
f getFileContent(filename){
try return file_content(filename)
catch FileNotFoundException {error: file not found}
}

Comments

[FanatPHP]

что предполагается делать в случае, если файл не найден?

[Сергей Соколов]

{error: file not found} в примере это типа выборос ошибки или её обработка (запись в лог)?

Answer 1

[FanatPHP]

Очень хороший вопрос и тема, в которой самое чудовищное количество самых дремучих северий на единицу кода.

В общем случае, по умолчанию, никаких проверок и траев с кетчами быть не должно.

Я понимаю, что это звучит богохульством для среднего пользователя похапе, но в реальности программы пишутся совсем по-другому.

Пример: В обоих приведенных выше случаях мы имеем масло масляное: попытка подменить пхп в выборосе ошибки. Вопрос - зачем? Если файл не найден, то РНР сам прекрасно сообщит нам об ошибке, причем в подробностях, и скажет в чем конкретно заключается проблема. А по строчке "file not found" иди гадай - путь ли кривой или в имени файла опечатка, или вообще пустоту передали.

Любые проверки надо делать только тогда, когда есть осмысленный сценарий их обработки.

И обсуждать выше приведенные примеры имеет смысл только если автор вопроса предоставит такой сценарий. тупое error: file not found таким сценарием не является. Так что в общем случае оставляем код в покое и не устраиваем никакого карго культа из перехвата ошибок.

Если чисто выбирать между двумя действиями (проверка и чтение) и одним (сразу читаем, потом ловим исключение),

то последнее предпочтительнее, поскльку это атомарная операция, в то время как между проверкой и чтением состояние системы сожет измениться (файл может быть удален).

Но повторюсь, если нет никакого осмысленного сценария обработки ошибки, то ловить её не надо.

Comments

[Олег Правдин]

Разумеется, речь идет о сценарии. Примеры только для описания паттернов, о которых я говорю :)
Вопрос заключается в том, как их писать тогда, когда они действительно нужны.

[FanatPHP]

Все зависит от сценария. Как я уже писал выше, в большинстве сценариев мы вообще ничего не пишем.

Напрягитесь, придумайте хотя бы парочку, и я напишу вам как с ними работать.

[Евгений]

FanatPHP, а если так? ))))
@file_get_contents()

[FanatPHP]

Евгений, в этом случае все просто - отрезать руки и засунуть туда, откуда они растут

[Олег Правдин]

FanatPHP, я приводил пример с файлом не потому что мне нужен файл, а потому что это первое что в голову пришло из банального :)
Посмотрите, пожалуйста, ветку комментариев к ответу от Daria Motorina, я там достаточно подробно объяснил почему у меня возник этот вопрос и ответ какого рода я ищу.
Вы просили сценарий - например такой: требуется создавать файл с дефолтным содержимым если его нет и сразу отдавать. Пример опять же исключительно иллюстрационный

f getFileContent(path){
    if (!File::isExist(path)) {
        file = new File(path);
        file.put("This is something default");
        file.save();
    } else {
        file = File::fromPath(path)
    }
    return file.content;
    return file_content(path)
}

# Вариант 2:
f getFileContent(path){
    try {
        file = File::fromPath(path)
        return file.content;
    }
    catch FileNotFoundException {
        file = new File(path);
        file.put("This is something default");
        file.save();
        return file.content
    }
}

[FanatPHP]

Олег Правдин, файлы - скользкая тема, тут по-хорошему нужны блокировки. Но в целом, как я уже писал выше, атомарная операция предпочтительнее составной.

Answer 2

[Сергей Соколов]

В таком примере, как вы привели, if() проверяет только условие существования файла или директории. А try-catch обработает бОльшее число ситуаций: если это не файл, а директория, если права не позволяют читать, если устройство гакнулось и не прочиталось.

пример автора вопроса

# Вариант 1:
f getFileContent(filename){
  if (!file_exists(filename)) {error: file not found}
  return file_content(filename)
}

# Вариант 2:
f getFileContent(filename){
  try return file_content(filename)
  catch FileNotFoundException {error: file not found}
}

По замыслу if отличается тем, что проверяет предусмотренные варианты, а исключения кидаются в непредусмотренных. Все бросаемые исключения надо документировать, чтобы их кто-то где-то, в итоге, поймал.

Условные операторы только для локальной логики внутри функции. Отлов исключений может иметь многоуровневую иерархию вне функции, класса. Например, случай не файла-а-папки отловится в одном, а случай нечитаемого сломанного устройства – на самом верхнем уровне всего приложения. И по-разному будут обработаны.

Внешние материалы по теме:

1. Пост по теме (на англ.)
   
2. скорость выполнения с исключениями и без (без быстрее)
   
3. Exception patterns, в частности:
   
   • Use Exceptions Instead Of Error Values
     
   • Don't Use Exceptions For Flow Control
     
   • Avoid Exceptions Whenever Possible
     
   • Code Without Exceptions
   
   
   

Comments

[Михаил Братеньков]

Но ведь автор
Во первых не кидает никаких исключений.

Во вторых в обоих случаях не выходит за пределы логики функции - исключение ловится в getFileContent и не уходит выше.

Так какой вариант обработки необходим здесь?

[Сергей Соколов]

Михаил Братеньков, в примере не вполне понятно: {error: file not found} это выброс ошибки или уже её обработка?

Оба варианта плохие тем, что скрывают причину облома внутри и надеются на пользователя этой функции, который по возвращённому пустому значению поймёт, что что-то пошло не так.

[Михаил Братеньков]

Сергей Соколов, обработка.

Продублирую расширенный пример который привел автор вопроса в соседней ветке. Цель - в случае если файл не существует создавать, наполнять содержимым и возвращать его, если существует - просто возвращать

f getFileContent(path){
    if (!File::isExist(path)) {
        file = new File(path);
        file.put("This is something default");
        file.save();
    } else {
        file = File::fromPath(path)
    }
    return file.content;
    return file_content(path)
}

# Вариант 2:
f getFileContent(path){
    try {
        file = File::fromPath(path)
        return file.content;
    }
    catch FileNotFoundException {
        file = new File(path);
        file.put("This is something default");
        file.save();
        return file.content
    }
}

[Сергей Соколов]

Михаил Братеньков, 1-й вариант лучше (закрываю глаза на два return подряд), т.к. отсутствие файла и необходимость создать дефолтный – штатная ситуация в логике приложения.

[Михаил Братеньков]

Сергей Соколов, объясните подробнее как определить является ли ситуация штатной или нет. Разве сам факт наличия в коде try{...}catch{...} не говорит о том что ситуация является штатной? Или он говорит о том что разработчик допускает возможность возникновения такой ситуации, но при этом не считает её нормой?

Если нет то верно ли понимаю что в блоке catch по определению должна быть описана логика сообщения об ошибке пользователю или разработчику? А если мы хотим что-бы отлов подобных ситуаций и их обработка происходила автоматически без участия людей (как в примере выше) то должны использовать вариант с if?

[FanatPHP]

Сергей Соколов, это расуждение очень хорошо подтверждает мысль что деление ситуаций на "штатные и нештатные" является очень условным и служить критерием не может

Answer 3

[Daria Motorina]

Try-catch отловит ошибку внутренней логики вызванного кода, а проверки передаваемых данных должны гарантировать, что с Вашей стороны все сделано правильно, т.е. ответ в том, что эти подходы не взаимозаменяемы

Comments

[Олег Правдин]

Есть кейсы, когда один подход может заменить другой. На примере из комментария к ответу выше:

# Вариант 1:
f getFileContent(filename){
if (!file_exists(filename)) {error: file not found}
return file_content(filename)
}

# Вариант 2:
f getFileContent(filename){
try return file_content(filename)
catch FileNotFoundException {error: file not found}
}

Чего следует придерживаться в PHP?

[Daria Motorina]

Олег Правдин, если file_exists бросает исключение, то проверка ее возврата на false ничего не даст, возврат false это штатная ситуация, а исключение - нештатная

[Олег Правдин]

Daria Motorina, В данном примере я рассматриваю file exists как булевую функцию. True если файл на месте и false если его нет.
Вопрос именно подходе к реализации. Python придерживается принципа EAFP, а какой из паттернов согласуется с идеологией PHP?

[Daria Motorina]

Олег Правдин, в php такого паттерна нет, и странно ожидать от php поведения python, если это другой язык. Вы же не ожидаете поведения java от javascript или поведения clojure от haskell, потому что Вы считаете, что какой-то из пары языков описан лучше - только документация по php описывает php. Какая разница, булевая функция или другая, если есть одно условие - бросается в ее теле исключение или нет? Бросается - ловите, не бросается - не ловите

[Олег Правдин]

Daria Motorina, паттерн в моем понимании - не зависящая от языка вещь. Просто идея для реализации чего-то по определенной схеме с какими-то логическими частями, которые как-то между собой взаимодействуют. Тот же MVC по сути это просто идея, реализовать которую можно на многих языках. В данном случае я привел 2 паттерна, оба реализуемы на PHP.
Вопрос по поводу "как делать лучше, когда можно сделать и так и эдак". Какой-то coding style или что-то в этом духе. Я привел в пример Python не потому что я ожидаю от PHP поведение Python, а потому что там когда-то сказали "Эгегей, товарищи, давайте придерживаться принципа, что у нас easier to ask for forgiveness than permission". Это не значит, что нельзя делать иначе, просто эта рекомендация и отправная точка для членов сообщества. Тот же PEP8 содержит рекомендации, как называть классы, методы, свойства. Он не заставляет, он направляет и вносит единообразие в кодовую базу разработчиков.
Именно такие ориентиры я и ищу в современном сообществе PHP - как делать лучше, как принято. Свой стиль я всегда успею придумать, но я предпочел бы не изобретать велосипед, а использовать общую практику, чтобы мой код был читаем для остальных, а
В данном примере я сначала могу могу проверить существование файла (и как-то это обработать, например создать новый файл с дефолтным текстом) и когда я буду уверен в том, что файл есть - я его прочитаю. Это вариант реализации 1.
А еще я могу вызвать чтение файла в блоке try и все, что я могу обработать - я кину в catch (например то же самое FileNotFoundException - создаю новый файл со стандартным текстом и отдаю его содержимое)

[FanatPHP]

огда я буду уверен в том, что файл есть -

Это заблуждение. См. мой дополненный ответ

Answer 4

[Александр]

Очень хорошие рассуждения, только вот они не учли один факт. Функции в php, которые работают с файлами не бросают Exception, а только Warning (да-да, при небольших модификациях можно из Warning сделать Exception).

Поэтому в php канонично, если в функции/методе есть throw - ее нужно обернуть в try - catch, а если функция позвращает true/false, то использовать if.

Ну и дополню, есть в функции есть throw, то проверки if, которые обходят этот throw, по своей сути - дублирование кода.

Answer 5

[profesor08]

Вариант 1 - ненужный, так как Вариант 2 обработает все. Более того, Вариант 1 гарантирует лишь то, что код условия не выполнится только тогда, когда файла, на момент проверки, нет и не было. Но может случиться так, что в период между проверкой и чтением файла, файл будет удален, или кеш не обновился, и тогда ты обломаешься со своей проверкой.

Answer 6

[Antonio Solo]

первый случай это не обработка ошибки, а обработка ситуации "отсутствия файла" - например предлагается создать новый, спросить имя, выбрать путь и т.д.

стоит иметь ввиду что между проверкой существования файла и попыткой его открытия есть временной лаг, и за время между проверкой и открытием может много чего случиться.

второй случай - это именно обработка ОШИБКИ.

---

резюме: если цель открыть заведомо существующий файл, то 2-й способ "каноничнее".

Answer 7

[Nujabes37]

Не совсем понятен вопрос, но. Try catch, нужен для обработки исключений. Проверки (если вы про конструкцию if (..)) нужны для булевых операций, все.

Comments

[Олег Правдин]

Есть два варианта (на псевдокоде):

# Вариант 1:
f getFileContent(filename){
if (!file_exists(filename)) {error: file not found}
return file_content(filename)
}

# Вариант 2:
f getFileContent(filename){
try return file_content(filename)
catch FileNotFoundException {error: file not found}
}

Какого из них стоит придерживаться в PHP?

Answer 8

[Дмитрий Дерепко]

if !file_exists
    return;
try
    readFile
catch 
    error

Comments

[Михаил Братеньков]

Это сарказм?